Sign in
Responses

Retrieves a model response with the given ID.

get/responses/{response_id}

Path parameters

response_idstring required
Example:resp_677efb5139a88190b512bc3fef8e535d

The ID of the response to retrieve.

Query parameters

includeIncludable[]

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.

Response

OK

metadataMetadata nullable required

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

temperaturenumber nullable required

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both.

top_pnumber nullable required

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

We generally recommend altering this or temperature but not both.

userstring

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

previous_response_idstring nullable

The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about conversation state.

max_output_tokensinteger nullable

An upper bound for the number of tokens that can be generated for a response, including visible output tokens and reasoning tokens.

instructionsstring nullable required

Inserts a system (or developer) message as the first item in the model's context.

When using along with previous_response_id, the instructions from a previous response will be not be carried over to the next response. This makes it simple to swap out system (or developer) messages in new responses.

truncation'auto' | 'disabled' nullable

The truncation strategy to use for the model response.

  • auto: If the context of this response and previous ones exceeds the model's context window size, the model will truncate the response to fit the context window by dropping input items in the middle of the conversation.
  • disabled (default): If a model response will exceed the context window size for a model, the request will fail with a 400 error.
idstring required

Unique identifier for this Response.

object'response' required

The object type of this resource - always set to response.

status'completed' | 'failed' | 'in_progress' | 'incomplete'

The status of the response generation. One of completed, failed, in_progress, or incomplete.

created_atnumber required

Unix timestamp (in seconds) of when this Response was created.

output_textstring nullable

SDK-only convenience property that contains the aggregated text output from all output_text items in the output array, if any are present. Supported in the Python and JavaScript SDKs.

parallel_tool_callsboolean required

Whether to allow the model to run tool calls in parallel.

Changes