Skip to content

Get Session

GET/v1/agents/sessions/{session_id}

Read a Session. Execution status is read live, so poll this endpoint or use the event stream to follow progress.

Path parameters

stringsession_idrequired

Session ID (ses_ prefix).

Session object

Returned by create, get, update, rename, archive, and unarchive.

stringidrequired

Session ID with the ses_ prefix.

stringstatusrequired

Execution status: idle, in_progress, or failed. requires_action is not supported yet and surfaces as 502 executor_contract_error.

stringlifecycle_statusrequired

active or archived. Archived Sessions reject input.

object · nullfailurerequired

Public failure with code, message, action, and optional retryable.

string · integer · stringagent_id · agent_version · modelrequired

Frozen Agent version and effective model.

object · object | nullagent · usagerequired

OpenAI-shaped snapshot of the effective Agent configuration, and token usage (null until a turn reports usage).

Optional<string · null>source · source_id

Origin of the Session. Sessions created with POST /v1/agents/sessions report direct and a null source_id.

integerrow_versionrequired

Compare-and-set token for rename, archive, and unarchive.