Skip to main content
POST
/
jobs
/
{id}
/
cancel
Cancel an in-flight job
curl --request POST \
  --url http://localhost:3001/api/v1/jobs/{id}/cancel \
  --header 'x-api-key: <api-key>'
{
  "data": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "result": {
      "images": [
        {
          "id": "<string>",
          "url": "<string>",
          "width": 0,
          "height": 0
        }
      ],
      "video": {
        "id": "<string>",
        "url": "<string>",
        "durationSeconds": 0,
        "thumbnailUrl": "<string>",
        "width": 0,
        "height": 0
      },
      "style": {
        "id": "<string>"
      }
    },
    "error": {
      "message": "<string>"
    }
  }
}

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

Response

OK

data
object
required