JavaScript
import Cadenya from '@cadenya/cadenya';
const client = new Cadenya({
apiKey: process.env['CADENYA_API_KEY'], // This is the default and can be omitted
});
const workspace = await client.workspaceAdmin.retrieve({
workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q',
});
console.log(workspace.metadata);import os
from cadenya import Cadenya
client = Cadenya(
api_key=os.environ.get("CADENYA_API_KEY"), # This is the default and can be omitted
)
workspace = client.workspace_admin.retrieve(
workspace_id="workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
)
print(workspace.metadata)package main
import (
"context"
"fmt"
"go.cadenya.com/cadenya-go"
"go.cadenya.com/cadenya-go/option"
)
func main() {
client := cadenya.NewClient(
option.WithAPIKey("My API Key"),
)
workspace, err := client.WorkspaceAdmin.Get(context.TODO(), cadenya.WorkspaceAdminGetParams{
WorkspaceID: cadenya.String("workspace_01HXKD2E5NQM3T9AYWCF133E3Q"),
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", workspace.Metadata)
}
require "cadenya"
cadenya = Cadenya::Client.new(api_key: "My API Key")
workspace = cadenya.workspace_admin.retrieve(workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q")
puts(workspace)cadenya workspace-admin retrieve \
--api-key 'My API Key' \
--workspace-id workspace_01HXKD2E5NQM3T9AYWCF133E3Qcurl --request GET \
--url https://api.cadenya.com/v1/account/workspaces/{workspaceId} \
--header 'Authorization: Bearer <token>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cadenya.com/v1/account/workspaces/{workspaceId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.get("https://api.cadenya.com/v1/account/workspaces/{workspaceId}")
.header("Authorization", "Bearer <token>")
.asString();{
"metadata": {
"id": "<string>",
"accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
"name": "<string>",
"profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
"externalId": "<string>",
"labels": {},
"createdAt": "2023-11-07T05:31:56Z"
},
"spec": {
"description": "<string>"
},
"info": {
"totalAvailableTools": 123,
"totalMemoryEntries": 123,
"totalAgents": 123,
"totalAgentVariations": 123
}
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Workspace Admin
Get a workspace by ID
Retrieves a workspace in the account by ID. Admin only.
GET
/
v1
/
account
/
workspaces
/
{workspaceId}
JavaScript
import Cadenya from '@cadenya/cadenya';
const client = new Cadenya({
apiKey: process.env['CADENYA_API_KEY'], // This is the default and can be omitted
});
const workspace = await client.workspaceAdmin.retrieve({
workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q',
});
console.log(workspace.metadata);import os
from cadenya import Cadenya
client = Cadenya(
api_key=os.environ.get("CADENYA_API_KEY"), # This is the default and can be omitted
)
workspace = client.workspace_admin.retrieve(
workspace_id="workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
)
print(workspace.metadata)package main
import (
"context"
"fmt"
"go.cadenya.com/cadenya-go"
"go.cadenya.com/cadenya-go/option"
)
func main() {
client := cadenya.NewClient(
option.WithAPIKey("My API Key"),
)
workspace, err := client.WorkspaceAdmin.Get(context.TODO(), cadenya.WorkspaceAdminGetParams{
WorkspaceID: cadenya.String("workspace_01HXKD2E5NQM3T9AYWCF133E3Q"),
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", workspace.Metadata)
}
require "cadenya"
cadenya = Cadenya::Client.new(api_key: "My API Key")
workspace = cadenya.workspace_admin.retrieve(workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q")
puts(workspace)cadenya workspace-admin retrieve \
--api-key 'My API Key' \
--workspace-id workspace_01HXKD2E5NQM3T9AYWCF133E3Qcurl --request GET \
--url https://api.cadenya.com/v1/account/workspaces/{workspaceId} \
--header 'Authorization: Bearer <token>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cadenya.com/v1/account/workspaces/{workspaceId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.get("https://api.cadenya.com/v1/account/workspaces/{workspaceId}")
.header("Authorization", "Bearer <token>")
.asString();{
"metadata": {
"id": "<string>",
"accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
"name": "<string>",
"profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
"externalId": "<string>",
"labels": {},
"createdAt": "2023-11-07T05:31:56Z"
},
"spec": {
"description": "<string>"
},
"info": {
"totalAvailableTools": 123,
"totalMemoryEntries": 123,
"totalAgents": 123,
"totalAgentVariations": 123
}
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}const workspace = await client.workspaceAdmin.retrieve({ workspaceId });
console.log(workspace.metadata.name);
workspace, err := client.WorkspaceAdmin.Get(ctx, cadenya.WorkspaceAdminGetParams{
WorkspaceID: cadenya.String(workspaceID),
})
fmt.Println(workspace.Metadata.Name)
workspace = cadenya.workspace_admin.retrieve(workspace_id: workspace_id)
puts workspace.metadata.name
curl "https://api.cadenya.com/v1/account/workspaces/${WORKSPACE_ID}" \
-H "Authorization: Bearer ${CADENYA_API_KEY}"
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Workspace ID to retrieve (path).
Example:
"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
Response
OK
AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Lifecycle status of the workspace. Archived workspaces reject all requests scoped to them. Server-populated.
Available options:
STATUS_ENABLED, STATUS_DISABLED, STATUS_ARCHIVED The workspace information
Show child attributes
Show child attributes
⌘I