Cancel

Cancel Batch

Cancel a batch. This is the equivalent of POST https://api.openai.com/v1/batches/{batch_id}/cancel

Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/cancel

Example Curl

curl http://localhost:4000/v1/batches/batch_abc123/cancel         -H "Authorization: Bearer sk-1234"         -H "Content-Type: application/json"         -X POST

POST/batches/{batch_id}/cancel

Authorization

APIKeyHeaderAPIKeyHeaderAPIKeyHeaderAPIKeyHeader

Path parameters

batch_id*Batch Id

Query parameters

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/batches/{batch_id}/cancel', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Cancel Batch

Cancel a batch. This is the equivalent of POST https://api.openai.com/v1/batches/{batch_id}/cancel

Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/cancel

Example Curl

curl http://localhost:4000/v1/batches/batch_abc123/cancel         -H "Authorization: Bearer sk-1234"         -H "Content-Type: application/json"         -X POST

POST/v1/batches/{batch_id}/cancel

Authorization

APIKeyHeaderAPIKeyHeaderAPIKeyHeaderAPIKeyHeader

Path parameters

batch_id*Batch Id

Query parameters

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/v1/batches/{batch_id}/cancel', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}