KEkeywordsai
OpenAI Batch

List batches

Changed on

List batches from the selected provider using customer-owned credentials. The response is relayed in the provider's OpenAI-compatible shape.

get/api/v1/batches

Request

  • Base URL
    https://api.respan.ai
  • URL
    https://api.respan.ai/api/v1/batches
  • Auth
    HTTP bearer

Query parameters

provider_idstring required

Provider route, for example openai or parasail.

afterstring

Provider pagination cursor.

limitinteger

Maximum batches requested from the provider.

Response

OpenAI-compatible batch list.

object'list' required
first_idstring nullable
last_idstring nullable
has_moreboolean

Example response

{
  "data": [
    {
      "id": "batch_abc123",
      "object": "batch",
      "endpoint": "/v1/chat/completions",
      "input_file_id": "file-abc123",
      "completion_window": "24h",
      "status": "in_progress",
      "created_at": 1710000000,
      "request_counts": {
        "total": 100,
        "completed": 97,
        "failed": 3
      }
    }
  ]
}

Changes

  • c30bcb383ee8Revision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • info

      api operation id openAiBatch_api_v1_batches_retrieve removed and replaced with api_v1_batches_retrieve

    • info

      api tag OpenAI Batch added

    • info

      api tag openAiBatch removed

    • info

      removed subschema #1 subschema #2 from the // response property oneOf list for the response status

  • b830b79cfd52Revision changes
    • info

      added the non-success response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status