/ 
OpenAPI-Client-OpenAI-0.20
River stage zero No dependents
/ OpenAPI::Client::OpenAI::Path::batches-batch_id-cancel

NAME

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

DESCRIPTION

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

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

POST /batches/{batch_id}/cancel

Cancels an in-progress batch. The batch will be in status `cancelling` for up to 10 minutes, before changing to `cancelled`, where it will have partial results (if any) available in the output file.

Operation ID

cancelBatch

$client->cancelBatch( ... );

Parameters

  • batch_id (in path) (Required) - The ID of the batch to cancel. Type: string

Responses

Status Code: 200

Batch is cancelling. Returns the cancelling batch's details.

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.