resources/batches/methods/list/index.md 2026-07-10 23:02 UTC to 2026-07-12 06:58 UTC

List batches

get /batches

List your organization's batches.

Query Parameters

• after: optional 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: optional number

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

Returns

• data: array of Batch

  • id: string

  • completion_window: string

    The time frame within which the batch should be processed.

  • created_at: number

    The Unix timestamp (in seconds) for when the batch was created.

  • endpoint: string

    The OpenAI API endpoint used by the batch.

  • input_file_id: string

    The ID of the input file for the batch.

  • object: "batch"

    The object type, which is always batch.

    • "batch"

  • status: "validating" or "failed" or "in_progress" or 5 more

    The current status of the batch.

    • "validating"

    • "failed"

    • "in_progress"

    • "finalizing"

    • "completed"

    • "expired"

    • "cancelling"

    • "cancelled"

  • cancelled_at: optional number

    The Unix timestamp (in seconds) for when the batch was cancelled.

  • cancelling_at: optional number

    The Unix timestamp (in seconds) for when the batch started cancelling.

  • completed_at: optional number

    The Unix timestamp (in seconds) for when the batch was completed.

  • error_file_id: optional string

    The ID of the file containing the outputs of requests with errors.

  • errors: optional object { data, object }

    • data: optional array of object { code, line, message, param }

      • code: optional string

        An error code identifying the error type.

      • line: optional number

        The line number of the input file where the error occurred, if applicable.

      • message: optional string

        A human-readable message providing more details about the error.

      • param: optional string

        The name of the parameter that caused the error, if applicable.

    • object: optional string

      The object type, which is always list.

  • expired_at: optional number

    The Unix timestamp (in seconds) for when the batch expired.

  • expires_at: optional number

    The Unix timestamp (in seconds) for when the batch will expire.

  • failed_at: optional number

    The Unix timestamp (in seconds) for when the batch failed.

  • finalizing_at: optional number

    The Unix timestamp (in seconds) for when the batch started finalizing.

  • in_progress_at: optional number

    The Unix timestamp (in seconds) for when the batch started processing.

  • metadata: optional 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.

  • model: optional string

    Model ID used to process the batch, like gpt-5-2025-08-07. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.

  • output_file_id: optional string

    The ID of the file containing the outputs of successfully executed requests.

  • request_counts: optional object { completed, failed, total }

    The request counts for different statuses within the batch.

    • completed: number

      Number of requests that have been completed successfully.

    • failed: number

      Number of requests that have failed.

    • total: number

      Total number of requests in the batch.

  • usage: optional BatchUsage

    Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used. Only populated on batches created after September 7, 2025.

    • input_tokens: number

      The number of input tokens.

    • input_tokens_details: object { cached_tokens }

      A detailed breakdown of the input tokens.

      • cached_tokens: number

        The number of tokens that were retrieved from the cache. More on prompt caching.

    • output_tokens: number

      The number of output tokens.

    • output_tokens_details: object { reasoning_tokens }

      A detailed breakdown of the output tokens.

      • reasoning_tokens: number

        The number of reasoning tokens.

    • total_tokens: number

      The total number of tokens used.

• has_more: boolean

• object: "list"

  • "list"

• first_id: optional string

• last_id: optional string

Example

curl https://api.openai.com/v1/batches \
    -H "Authorization: Bearer $OPENAI_API_KEY"

Response

{
  "data": [
    {
      "id": "id",
      "completion_window": "completion_window",
      "created_at": 0,
      "endpoint": "endpoint",
      "input_file_id": "input_file_id",
      "object": "batch",
      "status": "validating",
      "cancelled_at": 0,
      "cancelling_at": 0,
      "completed_at": 0,
      "error_file_id": "error_file_id",
      "errors": {
        "data": [
          {
            "code": "code",
            "line": 0,
            "message": "message",
            "param": "param"
          }
        ],
        "object": "object"
      },
      "expired_at": 0,
      "expires_at": 0,
      "failed_at": 0,
      "finalizing_at": 0,
      "in_progress_at": 0,
      "metadata": {
        "foo": "string"
      },
      "model": "model",
      "output_file_id": "output_file_id",
      "request_counts": {
        "completed": 0,
        "failed": 0,
        "total": 0
      },
      "usage": {
        "input_tokens": 0,
        "input_tokens_details": {
          "cached_tokens": 0
        },
        "output_tokens": 0,
        "output_tokens_details": {
          "reasoning_tokens": 0
        },
        "total_tokens": 0
      }
    }
  ],
  "has_more": true,
  "object": "list",
  "first_id": "batch_abc123",
  "last_id": "batch_abc456"
}

Example

curl https://api.openai.com/v1/batches?limit=2 \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "Content-Type: application/json"

Response

{
  "object": "list",
  "data": [
    {
      "id": "batch_abc123",
      "object": "batch",
      "endpoint": "/v1/chat/completions",
      "errors": null,
      "input_file_id": "file-abc123",
      "completion_window": "24h",
      "status": "completed",
      "output_file_id": "file-cvaTdG",
      "error_file_id": "file-HOWS94",
      "created_at": 1711471533,
      "in_progress_at": 1711471538,
      "expires_at": 1711557933,
      "finalizing_at": 1711493133,
      "completed_at": 1711493163,
      "failed_at": null,
      "expired_at": null,
      "cancelling_at": null,
      "cancelled_at": null,
      "request_counts": {
        "total": 100,
        "completed": 95,
        "failed": 5
      },
      "metadata": {
        "customer_id": "user_123456789",
        "batch_description": "Nightly job",
      }
    },
    { ... },
  ],
  "first_id": "batch_abc123",
  "last_id": "batch_abc456",
  "has_more": true
}