Skip to main content
POST
Cancel Job

Description

The Cancel Job endpoint stops an asynchronous job that is queued or still running. Use it to release capacity and avoid consuming credits on a run you no longer need.
  • Input: Provide the job_id of the job you want to stop.
  • Processing: The system marks the job as cancelled and stops further work on it.
  • Output: The job’s status record, in the same shape returned by Get job status.
  • Cancel superseded jobs when you resubmit with corrected input, rather than leaving both running.
  • Confirm the outcome by calling Get job status after cancelling.
  • Cancelling a completed job has no effect — check the status first if you are unsure.
See async jobs for the full job lifecycle.

Authorizations

api_key
string
header
required

Path Parameters

job_id
string
required

Response

Successful Response

job_id
string
required
status
string
required
input
V2JobInput · object
required
timing
V2JobTiming · object
required
additional_data
Additional Data · object
credit_usage
V2JobCreditUsage · object
results
V2JobResults · object
error
Error · object