Cancel Job

Cancel a pending job and receive a refund.

POST /v1/jobs/{jobId}/cancel

Cancel Job

cURL

curl --request POST \
  --url https://api.muvi.video/v1/jobs/{jobId}/cancel \
  --header 'Authorization: Bearer <token>'

200

{
  "jobId": "<string>",
  "status": "<string>",
  "refundedMicroCents": 123
}

Authentication

This endpoint requires an API key with the submit_job scope.

Authorization: Bearer YOUR_API_KEY

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

Code	Description
JOB_NOT_FOUND	The specified job ID does not exist.
UNAUTHORIZED_ACCESS	Your API key does not have access to this job.
JOB_CANNOT_BE_CANCELLED	The job is not in a cancellable state (not pending).

Examples

cURL

curl -X POST https://api.muvi.video/v1/jobs/job_abc123def456/cancel \
  -H "Authorization: Bearer YOUR_API_KEY"

Example Response

{
  "jobId": "job_abc123def456",
  "status": "cancelled",
  "refundedMicroCents": 500000
}