Skip to main content
POST
/
job
/
{job_id}
/
cancel
Cancel Job
curl --request POST \
  --url https://{base_url}/job/{job_id}/cancel \
  --header 'X-API-Key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "CANCELLED",
  "message": "Job cancelled successfully"
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication

Path Parameters

​
job_id
string
required

Job identifier

Response

Job cancelled successfully

​
id
string<uuid>

Cancelled job ID

​
status
enum<string>

Updated job status (will be CANCELLED)

Available options:
CANCELLED
Example:

"CANCELLED"

​
message
string

Confirmation message

Example:

"Job cancelled successfully"