jobs

Cancel a running/queued job.

A queued job ends at once. A running job ends when its run has stopped, usually a few seconds later, and the request holds up to 15 s for that. The answer is the job's state after the hold: status and finished_at once it has ended, or running with a detail naming the ?wait= call that returns when it has. canceled is false for a job that had already ended.

post/v1/jobs/{job_id}/cancel

Request

  • Base URL: https://api.japanfold.aiand.com
  • URL: https://api.japanfold.aiand.com/v1/jobs/{job_id}/cancel
  • Auth: one of:
    • none
    • HTTP bearer

Path parameters

job_idstring required

Response

The job after the cancel

canceledboolean
detailstring
finished_atstring date-time nullable
idstring
status'queued' | 'running' | 'succeeded' | 'failed' | 'canceled'

Changes

No recorded changes to this operation across all 1 revision of this API.