NAME

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

DESCRIPTION

This document describes the API endpoint at /responses.

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

POST /responses

Creates a model response. Provide [text](/docs/guides/text) or [image](/docs/guides/images) inputs to generate [text](/docs/guides/text) or [JSON](/docs/guides/structured-outputs) outputs. Have the model call your own [custom code](/docs/guides/function-calling) or use built-in [tools](/docs/guides/tools) like [web search](/docs/guides/tools-web-search) or [file search](/docs/guides/tools-file-search) to use your own data as input for the model's response.

Operation ID

createResponse

$client->createResponse( ... );

Request Body

Content Type: application/json

Responses

Status Code: 200

OK

Content Types:

  • application/json =item * text/event-stream

SEE ALSO

OpenAPI::Client::OpenAI::Path

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.