Create batch
Creates a batch from an uploaded JSONL file. Requests run asynchronously within 24 hours through the normal gateway path.
Creates a batch from an uploaded JSONL file. Requests run asynchronously within 24 hours through the normal gateway path. Each request is billed at the same per-token price as a live request, priced when it runs; no batch discount is applied.
Authorization
bearerAuth Bearer token authentication using API keys
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/batches" \ -H "Content-Type: application/json" \ -d '{ "input_file_id": "string", "endpoint": "/v1/chat/completions", "completion_window": "24h" }'{
"id": "string",
"object": "batch",
"endpoint": "/v1/chat/completions",
"errors": {
"object": "list",
"data": [
{
"code": "string",
"message": "string",
"param": "string",
"line": 0
}
]
},
"input_file_id": "string",
"completion_window": "string",
"status": "validating",
"output_file_id": "string",
"error_file_id": "string",
"created_at": 0,
"in_progress_at": 0,
"expires_at": 0,
"finalizing_at": 0,
"completed_at": 0,
"failed_at": 0,
"expired_at": 0,
"cancelling_at": 0,
"cancelled_at": 0,
"request_counts": {
"total": 0,
"completed": 0,
"failed": 0
},
"metadata": {
"property1": "string",
"property2": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}How is this guide?
Last updated on