Interface BatchCreateParams

interface BatchCreateParams {
    completion_window: "24h";
    endpoint:
        | "/v1/responses"
        | "/v1/chat/completions"
        | "/v1/embeddings"
        | "/v1/completions";
    input_file_id: string;
    metadata?: null | Metadata;
}

Properties

completion_window endpoint input_file_id metadata?

Properties

completion_window

completion_window: "24h"

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

endpoint

endpoint:
    | "/v1/responses"
    | "/v1/chat/completions"
    | "/v1/embeddings"
    | "/v1/completions"

The endpoint to be used for all requests in the batch. Currently /v1/responses, /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.

input_file_id

input_file_id: string

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 200 MB in size.

Optionalmetadata

metadata?: null | Metadata

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, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

Settings

Member Visibility

On This Page

Properties