OVID / OpenAPI-Client-OpenAI-0.21 / lib / OpenAPI / Client / OpenAI / Path / batches-batch_id-cancel.pod 
=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>.

=head1 PATHS


=head2 C<POST /batches/{batch_id}/cancel>

Cancels an in-progress batch. The batch will be in status C<cancelling> for up to 10 minutes, before changing to C<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


=head4 Status Code: C<200>

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


=head4 Content Types:

=over 4


=item * C<application/json>

Example (See the L<OpenAI spec for more detail|https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

    {
      "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",
      }
    }


=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