Archive an agent

Transitions an agent to STATE_ARCHIVED. Archived agents are hidden from list results and cannot be used for objectives; active schedules are paused.

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

Path parameters

workspaceIdstring required

Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q

Workspace ID.

idstring required

Example:agent_01HXKD2E5NQM3T9AYWCFMGWT9Y

Agent ID. Accepts the canonical agent_… form or the external_id:<value> form.

Request body

workspaceIdstring

Workspace ID.

idstring

Agent ID. Accepts the canonical agent_… form or the external_id:<value> form.

Example request

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

Response

state'STATE_UNSPECIFIED' | 'STATE_DRAFT' | 'STATE_PUBLISHED' | 'STATE_ARCHIVED' enum required

The current lifecycle state of the agent. Output only. Agents are created in STATE_DRAFT; use the :publish, :unpublish, :archive, and :unarchive actions to transition between states.

Example response

{
  "metadata": {
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
  },
  "info": {
    "createdBy": {
      "metadata": {
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
      }
    }
  }
}

Changes

Changed in 4 of the 57 revisions of this API.25

Jul 4, 202609ccecfe3ece11See the full diff
- ●
  removed the optional property spec/allOf[AgentSpec]/inputDataSchema from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property spec/allOf[AgentSpec]/systemPromptDataSchema to the response with the 200 status
  response-optional-property-added
Jul 2, 202606e0e37c149911See the full diff
- ●
  removed the optional property metadata/allOf[ResourceMetadata]/bundleKey from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property info/allOf[AgentInfo]/createdBy/metadata/createdAt to the response with the 200 status
  response-optional-property-added
This revision also has 27 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 11, 202608fde3ae3e372See the full diff
- ○
  added the optional property spec/allOf[AgentSpec]/enableEpisodicMemory to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property spec/allOf[AgentSpec]/episodicMemoryTtl to the response with the 200 status
  response-optional-property-added
Jun 9, 202613d98d37dd961See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history