Cancel a running job
cancel_jobDestructiveIdempotent
Cancel a job that is still pending or processing. This is the same request the web app Cancel button sends: the platform stops the work and refunds the credits of outputs that did not finish, which get_job then shows. Safe to repeat: cancelling a job that is already cancelling or already finished changes nothing and says so. Only jobs that belong to the account can be cancelled.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| job_id | Yes | The job id returned by generate_3d or generate. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| job_id | Yes | ||
| message | Yes | ||
| outcome | Yes |