Interface Response

interface Response {
    background?: null | boolean;
    created_at: number;
    error: null | ResponseError;
    id: string;
    incomplete_details: null | OpenAIClient.Responses.Response.IncompleteDetails;
    instructions: null | string | ResponseInputItem[];
    max_output_tokens?: null | number;
    metadata: null | Metadata;
    model: ResponsesModel;
    object: "response";
    output: ResponseOutputItem[];
    output_text: string;
    parallel_tool_calls: boolean;
    previous_response_id?: null | string;
    prompt?: null | ResponsePrompt;
    prompt_cache_key?: string;
    reasoning?: null | Reasoning;
    safety_identifier?: string;
    service_tier?:
        | null
        | "auto"
        | "default"
        | "flex"
        | "scale"
        | "priority";
    status?: ResponseStatus;
    temperature: null | number;
    text?: ResponseTextConfig;
    tool_choice:
        | ToolChoiceOptions
        | ToolChoiceAllowed
        | ToolChoiceTypes
        | ToolChoiceFunction
        | ToolChoiceMcp
        | ToolChoiceCustom;
    tools: OpenAIClient.Responses.Tool[];
    top_p: null | number;
    truncation?: null | "auto" | "disabled";
    usage?: ResponseUsage;
    user?: string;
}

Properties

background? created_at error id incomplete_details instructions max_output_tokens? metadata model object output output_text parallel_tool_calls previous_response_id? prompt? prompt_cache_key? reasoning? safety_identifier? service_tier? status? temperature text? tool_choice tools top_p truncation? usage? user?

Properties

Optionalbackground

background?: null | boolean

Whether to run the model response in the background. Learn more.

created_at

created_at: number

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

error

error: null | ResponseError

An error object returned when the model fails to generate a Response.

id

id: string

Unique identifier for this Response.

incomplete_details

incomplete_details: null | OpenAIClient.Responses.Response.IncompleteDetails

Details about why the response is incomplete.

instructions

instructions: null | string | ResponseInputItem[]

A system (or developer) message inserted into the model's context.

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

Optionalmax_output_tokens

max_output_tokens?: null | number

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

metadata

metadata: null | Metadata

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.

model

model: ResponsesModel

Model ID used to generate the response, like gpt-4o or o3. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.

object

object: "response"

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

output

output: ResponseOutputItem[]

An array of content items generated by the model.

  • The length and order of items in the output array is dependent on the model's response.
  • Rather than accessing the first item in the output array and assuming it's an assistant message with the content generated by the model, you might consider using the output_text property where supported in SDKs.

output_text

output_text: string

parallel_tool_calls

parallel_tool_calls: boolean

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

Optionalprevious_response_id

previous_response_id?: null | string

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

Optionalprompt

prompt?: null | ResponsePrompt

Reference to a prompt template and its variables. Learn more.

Optionalprompt_cache_key

prompt_cache_key?: string

Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more.

Optionalreasoning

reasoning?: null | Reasoning

o-series models only

Configuration options for reasoning models.

Optionalsafety_identifier

safety_identifier?: string

A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. Learn more.

Optionalservice_tier

service_tier?:
    | null
    | "auto"
    | "default"
    | "flex"
    | "scale"
    | "priority"

Specifies the latency tier to use for processing the request. This parameter is relevant for customers subscribed to the scale tier service:

  • If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.
  • If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.
  • If set to 'flex' or 'priority', then the request will be processed with the corresponding service tier. Contact sales to learn more about Priority processing.
  • When not set, the default behavior is 'auto'.

When this parameter is set, the response body will include the service_tier utilized.

Optionalstatus

status?: ResponseStatus

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

temperature

temperature: null | number

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.

Optionaltext

text?: ResponseTextConfig

Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more:

tool_choice

tool_choice:
    | ToolChoiceOptions
    | ToolChoiceAllowed
    | ToolChoiceTypes
    | ToolChoiceFunction
    | ToolChoiceMcp
    | ToolChoiceCustom

How the model should select which tool (or tools) to use when generating a response. See the tools parameter to see how to specify which tools the model can call.

tools

tools: OpenAIClient.Responses.Tool[]

An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter.

The two categories of tools you can provide the model are:

  • Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like web search or file search. Learn more about built-in tools.
  • Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. Learn more about function calling. You can also use custom tools to call your own code.

top_p

top_p: null | number

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.

Optionaltruncation

truncation?: null | "auto" | "disabled"

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.

Optionalusage

usage?: ResponseUsage

Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.

Optionaluser

user?: string

Deprecated

This field is being replaced by safety_identifier and prompt_cache_key. Use prompt_cache_key instead to maintain caching optimizations. A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. Learn more.

Settings

Member Visibility

On This Page

Properties