Sign in
Agents

Pause session

Pauses a session, whether it has started or not. A session that is running stops where it is and hands back the slot it was holding, so the next session in line can start; a session still waiting in line leaves the line. Either way it ends up Paused, and can be picked back up by sending it another message. Pausing a session that is already paused does nothing.

post/agents/sessions/pause

Request body

sessionIdstring required

The ID of the session, as returned by POST /agents/execute

Example request

{
  "sessionId": "agent_conversation_thread_01k1v4m0000000000000000000"
}

Response

The session is paused

sessionIdstring required

The ID of the session, as returned by POST /agents/execute

status'Pending' | 'InProgress' | 'Completed' | 'Failed' | 'Paused' | 'WaitingInLine' | 'Sleeping' required

Lifecycle status of the session after the pause

queueIdstring nullable required

The ID of the queue the session was on, if it was enqueued onto one

pausedSessionCountinteger required

How many sessions were paused: the session itself plus any child sessions it started

Example response

{
  "sessionId": "agent_conversation_thread_01k1v4m0000000000000000000",
  "status": "Paused"
}

Changes

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