Skip to main content
POST
Cancel Job

Authentication

This endpoint requires an API key with the submit_job scope.

Path Parameters

jobId
string
required
The unique identifier of the job to cancel.

Details

Only jobs with pending status can be cancelled. Jobs that are already processing, completed, failed, or cancelled cannot be cancelled. When a job is successfully cancelled, the charged credits are automatically refunded to your account.

Response

jobId
string
Unique identifier of the cancelled job.
status
string
Updated job status. Always "cancelled" on success.
refundedMicroCents
number
The amount refunded in micro-cents.

Error Codes

Examples

Example Response