=encoding utf8

=head1 NAME

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

=head1 DESCRIPTION

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

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

=head2 C<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.

=head3 Operation ID

C<cancelBatch>

    $client->cancelBatch( ... );

=head3 Parameters

=over 4

=item * C<batch_id> (in path) (Required) - The ID of the batch to cancel.
Type: C<string>


=back


=head3 Responses

=head3 Status Code: C<200>

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

Content Types:

=over 4

=item * C<application/json>

Example:

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



=back


=head1 SEE ALSO

L<OpenAPI::Client::OpenAI::Path>

=head1 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.

=cut
