POST
/
batches

Authorizations

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

Body

application/json
completion_window
enum<string>
required

The time frame within which the batch should be processed. Currently only 24h is supported.

Available options:
24h
endpoint
enum<string>
required

The endpoint to be used for all requests in the batch. Currently /v1/chat/completions, /v1/embeddings, and /v1/completions are supported. Note that /v1/embeddings batches are also restricted to a maximum of 50,000 embedding inputs across all requests in the batch.

Available options:
/v1/chat/completions,
/v1/embeddings,
/v1/completions
input_file_id
string
required

The ID of an uploaded file that contains requests for the new batch.

See upload file for how to upload a file.

Your input file must be formatted as a JSONL file, and must be uploaded with the purpose batch. The file can contain up to 50,000 requests, and can be up to 100 MB in size.

metadata
object | null

Optional custom metadata for the batch.

Response

200 - application/json
completion_window
string
required

The time frame within which the batch should be processed.

created_at
integer
required

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

endpoint
string
required

The Portkey API endpoint used by the batch.

id
string
required
input_file_id
string
required

The ID of the input file for the batch.

object
enum<string>
required

The object type, which is always batch.

Available options:
batch
status
enum<string>
required

The current status of the batch.

Available options:
validating,
failed,
in_progress,
finalizing,
completed,
expired,
cancelling,
cancelled
cancelled_at
integer

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

cancelling_at
integer

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

completed_at
integer

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

error_file_id
string

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

errors
object
expired_at
integer

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

expires_at
integer

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

failed_at
integer

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

finalizing_at
integer

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

in_progress_at
integer

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

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.

output_file_id
string

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

request_counts
object

The request counts for different statuses within the batch.