Cancel a job

POST

/api/v1/jobs/{job_id}/cancel

Cancels a queued or running job. Jobs that have already completed or failed cannot be cancelled.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

job_id*

Type

string

Required

Format

"uuid"

Responses

Successful Response

Content-Type

application/json

{

  

"id": "string",

  

"job_type": "string",

  

"status": "string",

  

"progress_current": 0,

  

"progress_total": 0,

  

"progress_detail": [

  

],

  

"result": {

  

  

"additionalProperties": "string"

  

},

  

"error": "string",

  

"created_at": "string",

  

"started_at": "string",

  

"completed_at": "string"

}

POST

/api/v1/jobs/{job_id}/cancel

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

job_id*

Samples

Powered by VitePress OpenAPI