NAME

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

DESCRIPTION

This document describes the API endpoint at /batches.

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

GET /batches

List your organization's batches.

Operation ID

listBatches

$client->listBatches( ... );

Parameters

• after (in query) (Optional) - 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.

  Type: string

• limit (in query) (Optional) - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

  Type: integer

  Default: 20

Responses

Status Code: 200

Batch listed successfully.

Content Types:

• application/json

  Example:

  {
     "first_id" : "batch_abc123",
     "last_id" : "batch_abc456",
     "data" : [
        {
           "errors" : {
              "data" : [
                 null
              ]
           },
           "request_counts" : null
        }
     ]
  }

POST /batches

Creates and executes a batch from an uploaded file of requests

Operation ID

createBatch

$client->createBatch( ... );

Request Body

Content Type: application/json

Responses

Status Code: 200

Batch created 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.

cpanm OpenAPI::Client::OpenAI

perl -MCPAN -e shell
install OpenAPI::Client::OpenAI