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.update({
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.update(
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.Update(context.TODO(), cadenya.WorkspaceAdminUpdateParams{
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.update(workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q")
puts(workspace)cadenya workspace-admin update \
--api-key 'My API Key' \
--workspace-id workspace_01HXKD2E5NQM3T9AYWCF133E3Qcurl --request PATCH \
--url https://api.cadenya.com/v1/account/workspaces/{workspaceId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"spec": {
"description": "<string>"
},
"updateMask": "<string>"
}
'<?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 => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'spec' => [
'description' => '<string>'
],
'updateMask' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.patch("https://api.cadenya.com/v1/account/workspaces/{workspaceId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"spec\": {\n \"description\": \"<string>\"\n },\n \"updateMask\": \"<string>\"\n}")
.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>"
}
]
}Update a workspace
Updates a workspace’s metadata (e.g. name) and spec. Admin only.
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.update({
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.update(
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.Update(context.TODO(), cadenya.WorkspaceAdminUpdateParams{
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.update(workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q")
puts(workspace)cadenya workspace-admin update \
--api-key 'My API Key' \
--workspace-id workspace_01HXKD2E5NQM3T9AYWCF133E3Qcurl --request PATCH \
--url https://api.cadenya.com/v1/account/workspaces/{workspaceId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"spec": {
"description": "<string>"
},
"updateMask": "<string>"
}
'<?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 => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'spec' => [
'description' => '<string>'
],
'updateMask' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.patch("https://api.cadenya.com/v1/account/workspaces/{workspaceId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"spec\": {\n \"description\": \"<string>\"\n },\n \"updateMask\": \"<string>\"\n}")
.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.update({
workspaceId,
metadata: { name: 'Staging' },
});
workspace, err := client.WorkspaceAdmin.Update(ctx,
cadenya.WorkspaceAdminUpdateParams{
WorkspaceID: cadenya.String(workspaceID),
Metadata: cadenya.WorkspaceAdminUpdateParamsMetadata{
Name: "Staging",
},
})
workspace = cadenya.workspace_admin.update(workspace_id: workspace_id, metadata: {name: "Staging"})
curl -X PATCH "https://api.cadenya.com/v1/account/workspaces/${WORKSPACE_ID}" \
-H "Authorization: Bearer ${CADENYA_API_KEY}" \
-H "Content-Type: application/json" \
-d '{ "metadata": { "name": "Staging" } }'
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Workspace ID to update (path).
"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
Body
UpdateAccountResourceMetadata contains the user-provided fields for updating an account-scoped resource. Read-only fields (id, account_id, profile_id) are excluded since they are set by the server.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Fields to update.
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.
STATUS_ENABLED, STATUS_DISABLED, STATUS_ARCHIVED The workspace information
Show child attributes
Show child attributes