NAME

OpenAPI::Client::OpenAI::Path::batches-batch_id - Documentation for the /batches/{batch_id} path.

DESCRIPTION

This document describes the API endpoint at /batches/{batch_id}.

PATHS

GET /batches/{batch_id}

Retrieves a batch.

Operation ID

retrieveBatch

$client->retrieveBatch( ... );

Parameters

• batch_id (in path) (Required) - The ID of the batch to retrieve.

  Type: string

Responses

Status Code: 200

Batch retrieved successfully.

Content Types:

• application/json

  Example (See the OpenAI spec for more detail):

  {
    "id": "batch_abc123",
    "object": "batch",
    "endpoint": "/v1/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 eval job",
    }
  }

SEE ALSO

OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE

Copyright (C) 2023-2025 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.