Cancel Job

Cancel a job (best effort; only queued/running).

POST /api/jobs/{job_id}/cancel

Cancel Job

cURL

curl --request POST \
  --url https://api.example.com/api/jobs/{job_id}/cancel \
  --header 'Authorization: Bearer <token>'

200

{
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Key · string | null

Path Parameters

job_id · string<uuid> · required

Response

200

application/json

Successful Response

Response for canceling a job.

job_id · string<uuid> · required

status · string · required