Sign in
Agents

Retrieve an agent session

Retrieves the current state of a managed agent session. See managing sessions.

get/agents/sessions/{session_id}

Path parameters

session_idstring required

The ID of the session.

Response

The requested session.

metadataobject required

Custom string key-value pairs attached to the session.

idstring required

The ID of the session.

object'agent.session' required

The object type. Always agent.session.

created_atinteger required

The Unix timestamp, in seconds, when the session was created.

last_active_atinteger required

The Unix timestamp, in seconds, when the session was last active.

status'idle' | 'in_progress' | 'requires_action' | 'failed' required

The current status of a session.

errorstring nullable required

The error that caused the session to fail, if any.

vault_idsstring[] required

The IDs of vaults made available to the session.

Changes

Changed in 2 of the 163 revisions of this API.11