Sessions

Rename session

Change the Session title with compare-and-set on row_version.

patch/v1/agents/sessions/{session_id}

Request

  • Base URL: https://api.sandbase.ai
  • URL: https://api.sandbase.ai/v1/agents/sessions/{session_id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

titlestring required
row_versioninteger required

Response

Session

idstring required

Session ID (ses_ prefix).

object'agent.session' required
agentobject required

OpenAI-shaped snapshot of the effective Agent configuration (id, name, model, instructions, multi_agent, reasoning, service_tier, text, tools).

agent_idstring required
agent_versioninteger required
titlestring required
modelstring required
metadataobject required
status'idle' | 'in_progress' | 'requires_action' | 'failed' required

Execution status. requires_action is not supported yet and surfaces as a 502 executor_contract_error.

lifecycle_status'active' | 'archived' required
sync_statusstring required
execution_statusstring required
row_versioninteger required
vault_idsstring[] required
usageobject nullable

Token usage; null until a turn reports usage.

created_atinteger required
last_active_atinteger required
updated_atinteger required
archived_atinteger nullable required
source'direct' | 'service' | 'schedule' | 'null' nullable
source_idstring nullable

Service or Schedule ID when source is service or schedule.

source_failure_codestring

Changes

No recorded changes to this operation across all 1 revision of this API.