Skip to main content
POST
/
tasks
/
{task_id}
/
cancel
Cancel Task
curl --request POST \
  --url https://api.example.com/tasks/{task_id}/cancel \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "status_reason": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "cleaned_at": "2023-11-07T05:31:56Z",
  "params": {},
  "task_metadata": {}
}

Path Parameters

​
task_id
string
required

Body

application/json
​
reason
string | null

Response

Successful Response

​
id
string
required
​
name
string | null
​
status
enum<string> | null
Available options:
CANCELED,
COMPLETED,
FAILED,
RUNNING,
TERMINATED,
TIMED_OUT,
DELETED
​
status_reason
string | null
​
created_at
string<date-time> | null
​
updated_at
string<date-time> | null
​
cleaned_at
string<date-time> | null
​
params
Task parameters · object
​
task_metadata
Task metadata · object