Skip to main content
GET
/
sessions
/
{session_id}
/
status
Probe the session's high-level status
curl --request GET \
  --url https://api.example.com/sessions/{session_id}/status \
  --header 'x-user-id: <x-user-id>'
{
  "session_id": "<string>"
}

Headers

x-user-id
string
required

Caller's user ID. Temporary header-based identity; will be replaced by JWT auth.

Path Parameters

session_id
string
required

Query Parameters

agent_id
string
required

Agent the session belongs to.

Response

Successful Response

Response body for probing a session's high-level status.

See :class:~agentscope.app._service.SessionStatus for the semantics of each status value and the precedence rules used to derive it.

session_id
string
required

The session that was probed.

status
enum<string>
required

The session's unified status. One of running (some worker holds the run lease), idle (no worker, context clean), awaiting_permission (no worker, context parked on HITL tool call), or awaiting_external_result (no worker, context parked on external executor).

Available options:
running,
idle,
awaiting_permission,
awaiting_external_result