List Batch

Authorizations

x-portkey-api-key

string

headerrequired

x-portkey-virtual-key

string

headerrequired

Query Parameters

after

string

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

limit

integer

default: 20

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

Response

200 - application/json

data

object[]

required

data.id

string

required

data.object

enum<string>

required

The object type, which is always batch.

Available options:

batch

data.endpoint

string

required

The Portkey API endpoint used by the batch.

data.errors

object

data.input_file_id

string

required

The ID of the input file for the batch.

data.completion_window

string

required

The time frame within which the batch should be processed.

data.status

enum<string>

required

The current status of the batch.

Available options:

validating,

failed,

in_progress,

finalizing,

completed,

expired,

cancelling,

cancelled

data.output_file_id

string

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

data.error_file_id

string

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

data.created_at

integer

required

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

data.in_progress_at

integer

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

data.expires_at

integer

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

data.finalizing_at

integer

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

data.completed_at

integer

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

data.failed_at

integer

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

data.expired_at

integer

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

data.cancelling_at

integer

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

data.cancelled_at

integer

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

data.request_counts

object

The request counts for different statuses within the batch.

data.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.

has_more

boolean

required

object

enum<string>

required

Available options:

list

first_id

string

last_id

string

API Reference

Chat Completions

Portkey Prompts

Embeddings

Images

Audio

Realtime

Other APIs

Completions

Moderations

Fine-tuning

Batch

Files

Assistants

Authorizations

Query Parameters

Response