Skip to main content
GET
/
batches
curl https://api.portkey.ai/v1/batches?limit=2 \
  -H "x-portkey-api-key: $PORTKEY_API_KEY" \
  -H "x-portkey-virtual-key: $PORTKEY_PROVIDER_VIRTUAL_KEY" \
  -H "Content-Type: application/json"
{
  "data": [
    {
      "id": "<string>",
      "endpoint": "<string>",
      "input_file_id": "<string>",
      "completion_window": "<string>",
      "created_at": 123,
      "errors": {
        "object": "<string>",
        "data": [
          {
            "code": "<string>",
            "message": "<string>",
            "param": "<string>",
            "line": 123
          }
        ]
      },
      "output_file_id": "<string>",
      "error_file_id": "<string>",
      "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": {}
    }
  ],
  "has_more": true,
  "first_id": "batch_abc123",
  "last_id": "batch_abc456"
}

Documentation Index

Fetch the complete documentation index at: https://portkey-docs-migration-04-ai-tools.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

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

Query Parameters

​
after
string

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

​
limit
integer
default:20

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

Response

200 - application/json

Batch listed successfully.

​
data
object[]
required
​
has_more
boolean
required
​
object
enum<string>
required
Available options:
list
​
first_id
string
Example:

"batch_abc123"

​
last_id
string
Example:

"batch_abc456"