Archive Agent

POST/v1/agents/{agent_id}/archive

Archive an Agent with compare-and-set. Archived Agents cannot start new Sessions.

Path parameters

stringagent_idrequired

Agent ID (agt_ prefix).

Headers

Optional<string>Idempotency-Key

Optional. When omitted the service generates one, so a retried request can create a duplicate. Send your own stable key for retries.

Request body

JSON object.

integerrow_versionrequired

The row_version you last read. A stale value returns 409.

curl -X POST https://api.sandbase.ai/v1/agents/agt_8c1f2b9e-3d4a-4f6b-9c2e-1a7d5e3b4c60/archive \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "row_version": 3
  }'

Response200 OK

{
  "id": "agt_8c1f2b9e-3d4a-4f6b-9c2e-1a7d5e3b4c60",
  "object": "agent",
  "name": "Research assistant",
  "model": "deepseek/deepseek-v4-flash",
  "instructions": "Answer with cited sources.",
  "tools": [],
  "text": {
    "format": {
      "type": "text"
    },
    "verbosity": "medium"
  },
  "reasoning": {
    "effort": null,
    "summary": null
  },
  "service_tier": "auto",
  "multi_agent": {
    "enabled": false,
    "max_concurrent_subagents": null
  },
  "visibility": "private",
  "status": "archived",
  "version": 3,
  "row_version": 4,
  "projection_status": "ready",
  "runtime_profile": "codex",
  "description": "",
  "metadata": {
    "team": "research"
  },
  "mcp_connections": [],
  "skills": [],
  "created_at": 1791273600,
  "updated_at": 1791273600,
  "archived_at": 1791360000
}