POST

Try POST /batches — OpenAI API

OpenAI playground

Create batch

Credentials

OpenAI API key · sent as Authorization

Kept in this tab only. Requests go through apicheats.dev's same-origin proxy straight to api.openai.com; the proxy stores and logs nothing about them.

Body application/json

5 body fields

input_file_id · required · string — The ID of an uploaded file that contains requests for the new batch. See [upload file](https://developers.openai.com/api/reference/resources/files/methods/create) for how to upload a file. Your input file must be formatted as a [JSONL file](https://developers.openai.com/api/docs/guides/batch#1-prepare-your-batch-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.
endpoint · required · string — The endpoint to be used for all requests in the batch. Currently `/v1/responses`, `/v1/chat/completions`, `/v1/embeddings`, `/v1/completions`, `/v1/moderations`, `/v1/images/generations`, `/v1/images/edits`, and `/v1/videos` are supported. Note that `/v1/embeddings` batches are also restricted to a maximum of 50,000 embedding inputs across all requests in the batch.
completion_window · required · string — The time frame within which the batch should be processed. Currently only `24h` is supported.
metadata · optional · 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, 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.
output_expires_after · optional · object — The expiration policy for the output and/or error file that are generated for a batch.