NAME

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

DESCRIPTION

This document describes the API endpoint at /responses.

PATHS

POST /responses

Creates a model response. Provide text or image inputs to generate text or JSON outputs. Have the model call your own custom code or use built-in tools like web search or file search to use your own data as input for the model's response.

Operation ID

createResponse

$client->createResponse( ... );

Parameters

Request Body

Content Type: application/json

Responses

Status Code: 200

OK

Content Types:

• application/json

  Example (See the OpenAI spec for more detail):

  {
     "created_at" : 1741476777,
     "error" : null,
     "id" : "resp_67ccd3a9da748190baa7f1570fe91ac604becb25c45c1d41",
     "incomplete_details" : null,
     "instructions" : null,
     "max_output_tokens" : null,
     "metadata" : {},
     "model" : "gpt-4o-2024-08-06",
     "object" : "response",
     "output" : [
        {
           "content" : [
              {
                 "annotations" : [],
                 "text" : "The image depicts a scenic landscape with a wooden boardwalk or pathway leading through lush, green grass under a blue sky with some clouds. The setting suggests a peaceful natural area, possibly a park or nature reserve. There are trees and shrubs in the background.",
                 "type" : "output_text"
              }
           ],
           "id" : "msg_67ccd3acc8d48190a77525dc6de64b4104becb25c45c1d41",
           "role" : "assistant",
           "status" : "completed",
           "type" : "message"
        }
     ],
     "parallel_tool_calls" : true,
     "previous_response_id" : null,
     "reasoning" : {
        "effort" : null,
        "summary" : null
     },
     "status" : "completed",
     "store" : true,
     "temperature" : 1,
     "text" : {
        "format" : {
           "type" : "text"
        }
     },
     "tool_choice" : "auto",
     "tools" : [],
     "top_p" : 1,
     "truncation" : "disabled",
     "usage" : {
        "input_tokens" : 328,
        "input_tokens_details" : {
           "cached_tokens" : 0
        },
        "output_tokens" : 52,
        "output_tokens_details" : {
           "reasoning_tokens" : 0
        },
        "total_tokens" : 380
     },
     "user" : null
  }

• text/event-stream

  Example (See the OpenAI spec for more detail):

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.