Archive a tool set

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 toolSet = await client.toolSets.archive('toolset_01HXKD2E5NQM3T9AYWCFNRMN74', {
  workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q',
});

console.log(toolSet.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
)
tool_set = client.tool_sets.archive(
    id="toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
    workspace_id="workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
)
print(tool_set.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"),
	)
	toolSet, err := client.ToolSets.Archive(
		context.TODO(),
		"toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
		cadenya.ToolSetArchiveParams{
			WorkspaceID: cadenya.String("workspace_01HXKD2E5NQM3T9AYWCF133E3Q"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", toolSet.Metadata)
}

require "cadenya"

cadenya = Cadenya::Client.new(api_key: "My API Key")

tool_set = cadenya.tool_sets.archive(
  "toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
  workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
)

puts(tool_set)

curl --request POST \
  --url https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{id}:archive \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{id}:archive",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  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.post("https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{id}:archive")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

{
  "metadata": {
    "id": "<string>",
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
    "name": "<string>",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
    "createdAt": "2023-11-07T05:31:56Z",
    "externalId": "<string>",
    "labels": {},
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "spec": {
    "description": "<string>",
    "adapter": {
      "type": "mcp",
      "mcp": {
        "url": "<string>",
        "headers": {},
        "includeTools": {
          "filters": [
            {
              "matcher": {
                "type": "exact",
                "exact": "<string>",
                "caseSensitive": true
              }
            }
          ]
        },
        "excludeTools": {
          "filters": [
            {
              "matcher": {
                "type": "exact",
                "exact": "<string>",
                "caseSensitive": true
              }
            }
          ]
        },
        "toolApprovals": {
          "type": "always",
          "always": true
        },
        "justInTime": {
          "enabled": true,
          "failObjectiveOnToolListError": true
        }
      }
    }
  },
  "info": {
    "toolCount": 123,
    "agentCount": 123,
    "lastSync": "2023-11-07T05:31:56Z",
    "createdBy": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "name": "<string>",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "externalId": "<string>",
        "labels": {},
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "email": "<string>",
        "name": "<string>"
      }
    },
    "availableTools": 123,
    "omittedTools": 123
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

POST

workspaces

{workspaceId}

tool_sets

{id}

:archive

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 toolSet = await client.toolSets.archive('toolset_01HXKD2E5NQM3T9AYWCFNRMN74', {
  workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q',
});

console.log(toolSet.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
)
tool_set = client.tool_sets.archive(
    id="toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
    workspace_id="workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
)
print(tool_set.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"),
	)
	toolSet, err := client.ToolSets.Archive(
		context.TODO(),
		"toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
		cadenya.ToolSetArchiveParams{
			WorkspaceID: cadenya.String("workspace_01HXKD2E5NQM3T9AYWCF133E3Q"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", toolSet.Metadata)
}

require "cadenya"

cadenya = Cadenya::Client.new(api_key: "My API Key")

tool_set = cadenya.tool_sets.archive(
  "toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
  workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
)

puts(tool_set)

curl --request POST \
  --url https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{id}:archive \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{id}:archive",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  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.post("https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{id}:archive")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

{
  "metadata": {
    "id": "<string>",
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
    "name": "<string>",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
    "createdAt": "2023-11-07T05:31:56Z",
    "externalId": "<string>",
    "labels": {},
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "spec": {
    "description": "<string>",
    "adapter": {
      "type": "mcp",
      "mcp": {
        "url": "<string>",
        "headers": {},
        "includeTools": {
          "filters": [
            {
              "matcher": {
                "type": "exact",
                "exact": "<string>",
                "caseSensitive": true
              }
            }
          ]
        },
        "excludeTools": {
          "filters": [
            {
              "matcher": {
                "type": "exact",
                "exact": "<string>",
                "caseSensitive": true
              }
            }
          ]
        },
        "toolApprovals": {
          "type": "always",
          "always": true
        },
        "justInTime": {
          "enabled": true,
          "failObjectiveOnToolListError": true
        }
      }
    }
  },
  "info": {
    "toolCount": 123,
    "agentCount": 123,
    "lastSync": "2023-11-07T05:31:56Z",
    "createdBy": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "name": "<string>",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "externalId": "<string>",
        "labels": {},
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "email": "<string>",
        "name": "<string>"
      }
    },
    "availableTools": 123,
    "omittedTools": 123
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

The gentle retirement. Archiving stops a tool set from syncing, hides it from the default list, and pulls its tools out of running agents, without throwing anything away.

await client.toolSets.archive(toolSetId, { workspaceId });
// state: 'STATE_ARCHIVED'

await client.toolSets.unarchive(toolSetId, { workspaceId });
// state: 'STATE_ACTIVE'

// state: STATE_ARCHIVED
_, err := client.ToolSets.Archive(ctx, toolSetID,
	cadenya.ToolSetArchiveParams{WorkspaceID: cadenya.String(workspaceID)})

// state: STATE_ACTIVE
_, err = client.ToolSets.Unarchive(ctx, toolSetID,
	cadenya.ToolSetUnarchiveParams{WorkspaceID: cadenya.String(workspaceID)})

cadenya.tool_sets.archive(tool_set_id, workspace_id: workspace_id)
# state: STATE_ARCHIVED

cadenya.tool_sets.unarchive(tool_set_id, workspace_id: workspace_id)
# state: STATE_ACTIVE

curl -X POST "https://api.cadenya.com/v1/workspaces/${WORKSPACE_ID}/tool_sets/${TOOL_SET_ID}:archive" \
  -H "Authorization: Bearer ${CADENYA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X POST "https://api.cadenya.com/v1/workspaces/${WORKSPACE_ID}/tool_sets/${TOOL_SET_ID}:unarchive" \
  -H "Authorization: Bearer ${CADENYA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{}'

Both directions are idempotent and return 200.

Archive works while assigned. Delete does not.

This is the reason archive exists. A tool set assigned to a variation refuses to delete with a 400. Archiving the same set succeeds:

DELETE .../tool_sets/{assigned}    → 400  "assigned to agent variations"
POST   .../tool_sets/{assigned}:archive → 200

So archive is how you retire a set that is still wired into an agent, without first hunting down every assignment.

The assignment survives

Archiving does not remove the variation assignment. It decouples the tools from running objectives while the set is archived, and unarchive restores it whole. Verified: a set assigned to a variation, archived, then unarchived, is still assigned to that variation afterward.

assign to a variation   → assigned
:archive                 → STATE_ARCHIVED, tools pulled from agents
:unarchive               → STATE_ACTIVE, still assigned, tools back

That is the difference from delete in one line: delete severs the assignment for good; archive parks it.

Finding archived sets

The default list shows only STATE_ACTIVE sets. An archived one appears only when you ask:

const archived = await client.toolSets.list({ workspaceId, state: 'STATE_ARCHIVED' });

A synced set does not re-sync while archived. Unarchive it and the next sync cycle picks it back up.

Delete a tool set

The permanent version, refused while assigned.

List tool sets

?state=STATE_ARCHIVED to see what you retired.

Create a tool set

What archiving stops syncing.

Add an assignment

The assignment that archive keeps and delete severs.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId

string

required

Workspace ID.

Example:

"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"

string

required

Tool set ID. Accepts the canonical ts_… form or the external_id: form.

Example:

"toolset_01HXKD2E5NQM3T9AYWCFNRMN74"

Body

application/json

Archive tool set request

Response

metadata

object

required

Standard metadata for persistent, named resources (e.g., agents, tools, prompts)

Show child attributes

spec

object

required

Show child attributes

state

enum<string>

required

read-only

The current lifecycle state of the tool set. Output only. Tool sets are created STATE_ACTIVE; use the :archive and :unarchive actions to transition between states.

Available options:

STATE_UNSPECIFIED,

STATE_ACTIVE,

STATE_ARCHIVED

info

object

Tool set information

Show child attributes

​Archive works while assigned. Delete does not.

​The assignment survives

​Finding archived sets

​Related

Delete a tool set

List tool sets

Create a tool set

Add an assignment

Authorizations

Path Parameters

Body

Response

Archive works while assigned. Delete does not.

The assignment survives

Finding archived sets

Related