POST
/
batches
/
{batch_id}
/
cancel
curl https://api.portkey.ai/v1/batches/batch_abc123/cancel \
  -H "x-portkey-api-key: $PORTKEY_API_KEY" \
  -H "x-portkey-virtual-key: $PORTKEY_PROVIDER_VIRTUAL_KEY" \
  -H "Content-Type: application/json" \
  -X POST

{
  "id": "<string>",
  "object": "batch",
  "endpoint": "<string>",
  "errors": {
    "object": "<string>",
    "data": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>",
        "line": 123
      }
    ]
  },
  "input_file_id": "<string>",
  "completion_window": "<string>",
  "status": "validating",
  "output_file_id": "<string>",
  "error_file_id": "<string>",
  "created_at": 123,
  "in_progress_at": 123,
  "expires_at": 123,
  "finalizing_at": 123,
  "completed_at": 123,
  "failed_at": 123,
  "expired_at": 123,
  "cancelling_at": 123,
  "cancelled_at": 123,
  "request_counts": {
    "total": 123,
    "completed": 123,
    "failed": 123
  },
  "metadata": {}
}

Authorizations

​
x-portkey-api-key
string
header
required
​
x-portkey-virtual-key
string
header
required

Path Parameters

​
batch_id
string
required

The ID of the batch to cancel.

Response

200 - application/json
Batch is cancelling. Returns the cancelling batch's details.
​
id
string
required
​
object
enum<string>
required

The object type, which is always batch.

Available options:
batch
​
endpoint
string
required

The Portkey API endpoint used by the batch.

​
input_file_id
string
required

The ID of the input file for the batch.

​
completion_window
string
required

The time frame within which the batch should be processed.

​
status
enum<string>
required

The current status of the batch.

Available options:
validating,
failed,
in_progress,
finalizing,
completed,
expired,
cancelling,
cancelled
​
created_at
integer
required

The Unix timestamp (in seconds) for when the batch was created.

​
errors
object
​
output_file_id
string

The ID of the file containing the outputs of successfully executed requests.

​
error_file_id
string

The ID of the file containing the outputs of requests with errors.

​
in_progress_at
integer

The Unix timestamp (in seconds) for when the batch started processing.

​
expires_at
integer

The Unix timestamp (in seconds) for when the batch will expire.

​
finalizing_at
integer

The Unix timestamp (in seconds) for when the batch started finalizing.

​
completed_at
integer

The Unix timestamp (in seconds) for when the batch was completed.

​
failed_at
integer

The Unix timestamp (in seconds) for when the batch failed.

​
expired_at
integer

The Unix timestamp (in seconds) for when the batch expired.

​
cancelling_at
integer

The Unix timestamp (in seconds) for when the batch started cancelling.

​
cancelled_at
integer

The Unix timestamp (in seconds) for when the batch was cancelled.

​
request_counts
object

The request counts for different statuses within the batch.

​
metadata
object | null

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.

Was this page helpful?

Suggest editsRaise issue