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

=head1 NAME

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

=head1 DESCRIPTION

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

=head1 PATHS


=head2 C<POST /responses>

Creates a model response. Provide L<text|https://platform.openai.com/docs/guides/text> or
L<image|https://platform.openai.com/docs/guides/images> inputs to generate L<text|https://platform.openai.com/docs/guides/text>
or L<JSON|https://platform.openai.com/docs/guides/structured-outputs> outputs. Have the model call
your own L<custom code|https://platform.openai.com/docs/guides/function-calling> or use built-in
L<tools|https://platform.openai.com/docs/guides/tools> like L<web search|https://platform.openai.com/docs/guides/tools-web-search>
or L<file search|https://platform.openai.com/docs/guides/tools-file-search> to use your own data
as input for the model's response.



=head3 Operation ID

C<createResponse>

    $client->createResponse( ... );

=head3 Parameters

=over 4

=back

=head3 Request Body
  
=head3 Content Type: C<application/json>

    
      

      
             

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




=item * C<text/event-stream>

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