Skip to main content
POST
TypeScript SDK

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

sessionId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

cancelQueued
boolean

Also cancel pending queued messages instead of continuing with the next queued message. Does not archive the session.

Response

Stop a session

cancelledSessions
integer
required
Required range: 0 <= x <= 9007199254740991
cancelledJobs
integer
required
Required range: 0 <= x <= 9007199254740991
stoppedRuntimeSessions
integer
required
Required range: 0 <= x <= 9007199254740991
interruptedRuntimeTurns
integer
required
Required range: 0 <= x <= 9007199254740991
cancelledRuntimeTurns
integer
required
Required range: 0 <= x <= 9007199254740991
state
object

Canonical session state after stopping and reconciling queued work.