⋙ Create Model Response

Creates a model response.

msg.payload Properties

input string | array

Text, image, or file inputs to the model, used to generate a response.

model string

Model ID used to generate the response.

include array

Specify additional output data to include in the model response.

instructions string

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

max_output_tokens integer

An upper bound for the number of tokens that can be generated for a response.

metadata object

Set of 16 key-value pairs that can be attached to an object.

parallel_tool_calls boolean

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

parallel_tool_calls boolean

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

previous_response_id string

The unique ID of the previous response to the model.

reasoning object

o-series models only. See official docs for option properties.

store boolean

Whether to store the generated model response for later retrieval via API.

stream boolean

If set to true, the model response data will be streamed to the client as it is generated using server-sent events.

temperature number

What sampling temperature to use, between 0 and 2.

text object

Configuration options for a text response from the model.

tool_choice string or object

How the model should select which tool (or tools) to use when generating a response.

tools array

An array of tools the model may call while generating a response. For Model Context Protocol (MCP) tools, each object in the array should follow this structure.

top_p number

An alternative to sampling with temperature, called nucleus sampling.

truncation string

The truncation strategy to use for the model response.

user string

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

⋙ Get Model Response

Retrieves a model response with the given ID.

msg.payload Properties

response_id string

The ID of the response to retrieve.

⋙ Delete Model Response

Deletes a model response with the given ID.

msg.payload Properties

response_id string

The ID of the response to delete.

⋙ List Input Items

Returns a list of input items for a given response.

msg.payload Properties

response_id string

The ID of the response to retrieve input items for.

after string

An item ID to list items after, used in pagination.

before string

An item ID to list items before, used in pagination.

limit integer

A limit on the number of objects to be returned.

order string

The order to return the input items in. Default is asc.