Sessions
Sessions.update
POST
/v1/sessions/{id}x-api-key<token>
Workspace API key. Read from the x-api-key header by src/auth/api-key.ts. A key that is present and does not authenticate is final — no other scheme is consulted.
In: header
Path Parameters
id*string
Match
^(?:ses|sesn)_[A-Za-z0-9_-]+$Header Parameters
idempotency-key?string
orca-beta?string
anthropic-beta?string
Accepted for Anthropic SDK compatibility and ignored. No value of this header changes request handling. Typed as a free-form string rather than an enum because this service recognises no specific beta value.
Request Body
application/json
Body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/sessions/string" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "string", "type": "session", "agent": { "id": "string", "type": "agent", "name": "string", "description": "string", "version": 1, "model": { "id": "string", "speed": "standard", "effort": { "type": "low" } }, "system": "string", "tools": [ { "type": "agent_toolset", "default_config": { "enabled": true, "permission_policy": { "type": "always_allow" } }, "configs": [ { "enabled": true, "permission_policy": { "type": "always_allow" }, "name": "string" } ] } ], "mcp_servers": [ { "name": "string", "type": "url", "url": "http://example.com" } ], "skills": [ { "type": "anthropic", "skill_id": "string", "version": "string" } ], "multiagent": { "type": "coordinator", "agents": [ { "id": "string", "type": "agent", "name": "string", "description": "string", "version": 1, "model": { "id": "string", "speed": "standard", "effort": { "type": "low" } }, "system": "string", "tools": [ { "type": "agent_toolset", "default_config": { "enabled": true, "permission_policy": { "type": "always_allow" } }, "configs": [ { "enabled": true, "permission_policy": { "type": "always_allow" }, "name": "string" } ] } ], "mcp_servers": [ { "name": "string", "type": "url", "url": "http://example.com" } ], "skills": [ { "type": "anthropic", "skill_id": "string", "version": "string" } ] } ] } }, "title": "string", "metadata": { "property1": "string", "property2": "string" }, "environment_id": "string", "vault_ids": [ "string" ], "status": "idle", "stats": { "active_seconds": 0, "duration_seconds": 0 }, "timing": { "started_at": "2019-08-24T14:15:22Z", "last_active_at": "2019-08-24T14:15:22Z", "active_seconds": 0, "duration_seconds": 0 }, "deployment_id": "string", "outcome_evaluations": [ { "type": "outcome_evaluation", "outcome_id": "string", "description": "string", "result": "string", "explanation": "string", "iteration": 0, "completed_at": "2019-08-24T14:15:22Z" } ], "usage": { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 }, "archived_at": "2019-08-24T14:15:22Z", "resources": [ { "id": "string", "type": "file", "file_id": "string", "mount_path": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}