Skip to main content

OpenAIResponse

idstringrequired

Possible values: Value must match regular expression ^resp_

objectstringrequired
Constant value: response
created_atintegerrequired
completed_atinteger | nullnullablerequired

Unix timestamp in seconds only when status is completed; null for every other status.

statusstringrequired

Possible values: [queued, in_progress, completed, failed, cancelled, incomplete]

backgroundbooleanrequired
error objectrequired
oneOf
null
incomplete_details objectrequired
oneOf
null
instructionsstring | nullnullablerequired
max_output_tokensinteger | nullnullablerequired
max_tool_callsnullrequired
modelstringrequired
output object[]required
  • Array [
  • idstring

    Possible values: Value must match regular expression ^msg_

    typestringrequired
    Constant value: message
    rolestringrequired

    Possible values: [user, assistant, system, developer]

    content objectrequired
    oneOf
    string

    Possible values: non-empty

    statusstring

    Possible values: [in_progress, completed, incomplete]

  • ]
  • parallel_tool_callsbooleanrequired
    Constant value: false
    previous_response_idstring | nullnullablerequired
    conversation objectrequired
    oneOf
    null
    metadata objectrequired
    property name*string

    Possible values: <= 512 characters

    storebooleanrequired
    temperaturenumber | nullnullablerequired
    top_pnumber | nullnullablerequired
    toolsarrayrequired
    tool_choicestringrequired
    Constant value: auto
    reasoning objectrequired
    property name*any
    text objectrequired
    format objectrequired
    typestringrequired
    Constant value: text
    verbositystring

    Possible values: [low, medium, high]

    truncationstringrequired
    Constant value: disabled
    usernullrequired
    usage objectrequired
    oneOf
    null
    OpenAIResponse
    {
    "id": "string",
    "object": "response",
    "created_at": 0,
    "completed_at": 0,
    "status": "queued",
    "background": true,
    "error": "null",
    "incomplete_details": "null",
    "instructions": "string",
    "max_output_tokens": 0,
    "max_tool_calls": "null",
    "model": "string",
    "output": [
    {
    "id": "string",
    "type": "message",
    "role": "user",
    "content": "string",
    "status": "in_progress"
    }
    ],
    "parallel_tool_calls": true,
    "previous_response_id": "string",
    "conversation": "null",
    "metadata": {},
    "store": true,
    "temperature": 0,
    "top_p": 0,
    "tools": [
    null
    ],
    "tool_choice": "auto",
    "reasoning": {},
    "text": {
    "format": {
    "type": "text"
    },
    "verbosity": "low"
    },
    "truncation": "disabled",
    "user": "null",
    "usage": "null"
    }