Skip to main content
POST
Cancels the task the message belongs to, since the agent works on one reply at a time. Equivalent to POST /tasks/{task_id}/cancel.

Authorizations

Authorization
string
header
required

Requires an API key. See the Authentication guide.

Path Parameters

message_id
string
required
task_id
string
required

Body

application/json

Omit the body for a graceful cancel.

force
boolean
default:false

Response

200 - application/json

Cancel accepted.

id
string
required
status
enum<string>
required
Available options:
cancelling,
cancelled,
backgrounded
type
string
default:message_status
Allowed value: "message_status"