POST
/
batches
curl https://api.portkey.ai/v1/batches \
  -H "x-portkey-api-key: $PORTKEY_API_KEY" \
  -H "x-portkey-virtual-key: $PORTKEY_PROVIDER_VIRTUAL_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "input_file_id": "file-abc123",
    "endpoint": "/v1/chat/completions",
    "completion_window": "24h"
  }'

{
  "id": "<string>",
  "object": "batch",
  "endpoint": "<string>",
  "errors": {
    "object": "<string>",
    "data": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>",
        "line": 123
      }
    ]
  },
  "input_file_id": "<string>",
  "completion_window": "<string>",
  "status": "validating",
  "output_file_id": "<string>",
  "error_file_id": "<string>",
  "created_at": 123,
  "in_progress_at": 123,
  "expires_at": 123,
  "finalizing_at": 123,
  "completed_at": 123,
  "failed_at": 123,
  "expired_at": 123,
  "cancelling_at": 123,
  "cancelled_at": 123,
  "request_counts": {
    "total": 123,
    "completed": 123,
    "failed": 123
  },
  "metadata": {}
}

Authorizations

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

Body

application/json

Gateway supported body params for OpenAI, Azure OpenAI and VertexAI.

Response

200 - application/json

Batch created successfully.

The response is of type object.