ToolService
Tool Sets

Archive a tool set

Changed on

Transitions a tool set to STATE_ARCHIVED. Syncing stops, the tool set is hidden from list results, its tools are no longer offered to objectives, and new variation assignments are rejected. Existing assignments are retained, and history is preserved — unlike delete, archiving works while the tool set is still assigned to agent variations.

post/v1/workspaces/{workspaceId}/tool_sets/{id}:archive

Request

  • Base URL
    https://api.cadenya.com
  • URL
    https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{id}:archive
  • Auth
    HTTP bearer

Path parameters

workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q

Workspace ID.

idstring required
Example:toolset_01HXKD2E5NQM3T9AYWCFNRMN74

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

Request body

workspaceIdstring

Workspace ID.

idstring

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

Example request

{
  "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
  "id": "toolset_01HXKD2E5NQM3T9AYWCFNRMN74"
}

Response

OK

state'STATE_UNSPECIFIED' | 'STATE_ACTIVE' | 'STATE_ARCHIVED' enum required

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.

Changes

  • 3ecc1debabfaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to no type for status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added discriminator to / response property for the response status

  • ca78d3d0b7c2Revision changes
    • info

      added the optional property // to the response with the status