Skip to main content
POST
Interrupt running work

Authorizations

Authorization
string
header
required

Boat bearer token in the form boat_.... Service API keys authenticate sandbox operations.

Path Parameters

sandboxId
string
required

Public Sandbox id returned by create/list/get sandbox calls.

Pattern: ^bx_[23456789abcdefghjkmnpqrstuvwxyz]{8}$

Query Parameters

conversation
string

Interrupt only this conversation id. Omit to interrupt the whole sandbox.

Response

Interrupt requested.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

Example:

"sandbox.stopping"

id
string
required
status
string
required
Example:

"archiving"

sandbox
object | null