Skip to main content
POST
Required scope: write

Request body

object
string
string
A text string, a single input item object, or an array of input items.
string
object[]
string
Tool selection mode (auto, none, required) or a specific function as {'type': 'function', 'function': {'name': …}}.
integer
object
object
OpenAI Responses-style text config; format takes the same shape as response_format.
string
string
string
object[]
object[]
object[]
boolean
object
integer
integer
number
boolean
When true, emit an SSE stream instead of a JSON body.
object
string
boolean
object
boolean
When true, include the full recursive payload under x_nsr.

Response

object
string
required
string
required
integer
required
Unix timestamp (seconds).
string
required
string
required
object[]
required
string
Convenience concatenation of the output text. Omitted when there is none.
object
required
object
Echoed request metadata. Omitted when absent.
string
Omitted when absent.
object
Full recursive NSR payload. Present only when include_nsr_metadata is true.

Status codes

Last modified on August 31, 2026