Responses

Create a response

Create a response from a string or an array of input items (messages, tool call and tool output items, and reasoning items from an earlier turn). Function, custom, namespace, shell, local shell, apply patch and client tool search tools are supported, and strict, tool_choice (including allowed_tools) and parallel_tool_calls: false are enforced. Reasoning comes back as a reasoning item with encrypted_content you can send back unchanged, readable reasoning_text content, and a summary when reasoning.summary is set. Responses are stored for 30 days by default (store), so a later request can continue from one with previous_response_id, or keep its turns in a conversation; with background: true the response runs on its own and is retrieved later. See the Responses API compatibility table and Data retention in the introduction.

Request body

instructionsstring

toolsobject[]

function (with strict), custom, namespace, shell, local_shell, apply_patch and client tool_search tools. Web search is left out (see x-openscale-ignored-tools); other hosted tools are refused.

tool_choiceunknown

parallel_tool_callsboolean

textobject

Structured outputs: { "format": { "type": "json_schema", ... } } or json_object. json_object works whether or not your prompt mentions JSON.

max_output_tokensinteger

temperaturenumber

top_pnumber

streamboolean

metadataobject

storeboolean

Store the response for 30 days, for previous_response_id, retrieval and input_items. false stores nothing. Always false when the account has zero data retention on.

previous_response_idstring

Continue from a stored response: its input and output (and those of the responses before it) come before input. Its instructions do not carry over.

backgroundboolean

Run the response on its own: answered at once with a queued response; retrieve it, stream it, or cancel it by id.

userstring

reasoningobject

Reasoning control: effort (none to xhigh) and summary (auto, concise or detailed returns a readable summary).

Response

The response, or a typed SSE stream when stream is true.

idstring required

object'response' required

created_atinteger required

service_tier'default' | 'priority'

The tier that served the response: priority in fast mode.

Example response

{
  "id": "resp_example",
  "output": [
    {
      "id": "msg_example"
    }
  ]
}

Create a response

Request

Request body

Response 200OK

Example response

Changes

Response