Cancel a pending or in-progress async chat job.

POST

jobs

{job_id}

cancel

curl --request POST \
  --url https://api.example.com/v1/jobs/{job_id}/cancel \
  --header 'Authorization: Bearer <token>'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

authorization

string | null

job_id

string

required

Successful Response

Cancel a pending or in-progress async chat job.

curl --request POST \
  --url https://api.example.com/v1/jobs/{job_id}/cancel \
  --header 'Authorization: Bearer <token>'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}