Cancel Batch

Cancels an in-progress batch. The batch will be in status `cancelling` for up to 10 minutes, before changing to `cancelled`, where it will have partial results (if any) available in the output file.

POSThttps://api.portkey.ai/v1/batches/{batch_id}/cancel

Path parameters

batch_id*string

The ID of the batch to cancel.

Response

200

Batch is cancelling. Returns the cancelling batch's details.

Body

application/json

id*string

object*enum

The object type, which is always batch.

batch

endpoint*string

The Portkey API endpoint used by the batch.

errorsobject

input_file_id*string

The ID of the input file for the batch.

completion_window*string

The time frame within which the batch should be processed.

status*enum

The current status of the batch.

validatingfailedin_progressfinalizingcompletedexpiredcancellingcancelled

output_file_idstring

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

error_file_idstring

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

created_at*integer

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

in_progress_atinteger

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

expires_atinteger

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

finalizing_atinteger

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

completed_atinteger

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

failed_atinteger

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

expired_atinteger

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

cancelling_atinteger

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

cancelled_atinteger

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

request_countsobject

The request counts for different statuses within the batch.

metadatanullable object

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.

Response

{
  "id": "text",
  "object": "batch",
  "endpoint": "text",
  "errors": {
    "object": "text",
    "data": [
      {
        "code": "text",
        "message": "text",
        "param": "text"
      }
    ]
  },
  "input_file_id": "text",
  "completion_window": "text",
  "status": "validating",
  "output_file_id": "text",
  "error_file_id": "text",
  "request_counts": {}
}