=encoding utf8

=head1 NAME

OpenAPI::Client::OpenAI::Path::responses-response_id-cancel - Documentation for the /responses/{response_id}/cancel path.

=head1 DESCRIPTION

This document describes the API endpoint at C</responses/{response_id}/cancel>.

=head1 PATHS


=head2 C<POST /responses/{response_id}/cancel>

Cancel a response


Cancels a model response with the given ID. Only responses created with
the C<background> parameter set to C<true> can be cancelled. 
L<Learn more|https://platform.openai.com/docs/guides/background>.



=head3 Operation ID

C<cancelResponse>

    $client->cancelResponse( ... );

=head3 Parameters

=over 4

=item * C<response_id> (in path) (Required) - The ID of the response to cancel.

Type: C<string>



=back


=head3 Responses


=head4 Status Code: C<200>

OK


=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>):



=back

=head4 Status Code: C<404>

Not Found


=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>):



=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