Skip to main content
POST
Cancel a running task

Authorizations

Authorization
string
header
required

Send your API key in the Authorization header as Bearer <API_KEY>.

Path Parameters

task_id
string
required

Task ID

Query Parameters

biz_code
integer<int32>

Optional business cancellation code (for your own tracking/analytics).

Response

Run canceled.

task_id
string
required

Task ID

status
enum<string>
required

Public lifecycle status of a bot run.

Available options:
created,
running,
finished,
canceled,
pausing,
paused,
failed
updated_at
string<date-time>
required

Time when the task record was last updated.