OVID / OpenAPI-Client-OpenAI-0.21 / lib / OpenAPI / Client / OpenAI / Path / responses-response_id.pod 
=encoding utf8

=head1 NAME

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

=head1 DESCRIPTION

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

=head1 PATHS


=head2 C<DELETE /responses/{response_id}>

Deletes a model response with the given ID.



=head3 Operation ID

C<deleteResponse>

    $client->deleteResponse( ... );

=head3 Parameters

=over 4

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

Type: C<string>



=back


=head3 Responses


=head4 Status Code: C<200>

OK


=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

=head2 C<GET /responses/{response_id}>

Retrieves a model response with the given ID.



=head3 Operation ID

C<getResponse>

    $client->getResponse( ... );

=head3 Parameters

=over 4

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

Type: C<string>



=item * C<include> (in query) (Optional) - Specify additional output data to include in the response. Currently
supported values are:
- `file_search_call.results`: Include the search results of
  the file search tool call.
- `message.input_image.image_url`: Include image urls from the input message.
- `computer_call_output.output.image_url`: Include image urls from the computer call output.


Type: C<array>



=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

=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