Skip to main content
DELETE
Cancel or delete task
This endpoint automatically performs a cancel or delete based on the task’s current status, as follows:

Authorizations

Authorization
string
header
required

HTTP: Bearer Auth

  • Security Scheme Type: http
  • HTTP Authorization Scheme: Bearer API_key, used to verify account information, can be found in Account Management>API Keys.

Path Parameters

task_id
string
required

ID of the task to cancel or delete.

Response

task_id
string

ID of the affected task.

action
enum<string>

The action actually performed: cancelled (only for the queued state) or deleted (remove a succeeded or failed task record).

Available options:
cancelled,
deleted
status
enum<string>

Operation result: cancelled or deleted.

Available options:
cancelled,
deleted