Skip to main content
POST
Cancel a running session

Authorizations

X-Api-Key
string
header
required

Workspace API key, created in the dashboard under Settings → API Keys.

Path Parameters

id
string
required

Session ID.

Query Parameters

workspaceId
string<uuid>

Workspace the request is scoped to. Optional for API keys: a key is bound to one workspace when it is created, and naming any other workspace returns an opaque 404.

Body

application/json

Optional workspace scope. Takes precedence over ?workspaceId= when present and non-empty.

workspaceId
string<uuid>

Optional for workspace-scoped API keys.

Response

Stop request acknowledged

ok
boolean
required
status
string
required

stopping | noop

sessionId
string
required
reason
string