OpenAPI::Client::OpenAI::Path::responses-response_id(3)

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

DESCRIPTION
This document describes the API endpoint at "/responses/{response_id}".

PATHS

  "DELETE /responses/{response_id}"
Deletes a model response with the given ID.

Operation ID

"deleteResponse"

    $client->deleteResponse( ... );

Parameters

•   "response_id" (in path) (Required) - The ID of the response to delete.

    Type: "string"

Responses

Status Code: 200

OK

Status Code: 404

Not Found

Content Types:

•   "application/json"

    Example (See the OpenAI spec for more detail <https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

  "GET /responses/{response_id}"
Retrieves a model response with the given ID.

Operation ID

"getResponse"

    $client->getResponse( ... );

Parameters

•   "response_id" (in path) (Required) - The ID of the response to retrieve.

    Type: "string"

•   "include" (in query) (Optional) - Additional fields to include in the response. See the `include` parameter for Response creation above for more information.

    Type: "array"

•   "stream" (in query) (Optional) - If set to true, the model response data will be streamed to the client as it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format). See the [Streaming section below](/docs/api-reference/responses-streaming) for more information.

    Type: "boolean"

•   "starting_after" (in query) (Optional) - The sequence number of the event after which to start streaming.

    Type: "integer"

Responses

Status Code: 200

OK

Content Types:

•   "application/json"

    Example (See the OpenAI spec for more detail <https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

        {
           "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
        }

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.