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}.

See the examples/ directory in the distribution for examples of how to use this.

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:

  {
     "errors" : {
        "data" : [
           null
        ]
     },
     "request_counts" : null
  }

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.