Sign in

v4

OpenAPI 3.1.02026-08-01166346466.7 KB
responses

Retrieve a response

Retrieve a previously stored response by ID.

get/v1/responses/{response_id}

Path parameters

response_idstring required

ID of the response

ID of the response

Query parameters

includestring[] nullable

Extra fields to include, e.g. store_search_call.results; unsupported values are ignored

Extra fields to include, e.g. store_search_call.results; unsupported values are ignored

Response

The stored response

idstring required
object'response'
created_atinteger required
titlestring nullable

Short display title derived from the first user message (Mixedbread extension)

status'in_progress' | 'completed' | 'failed' | 'incomplete' required

Lifecycle of a response; values mirror the official Responses API.

instructionsstring nullable
modelstring required
parallel_tool_callsboolean
previous_response_idstring nullable
storeboolean
temperaturenumber nullable
top_pnumber nullable
max_output_tokensinteger nullable
max_tool_callsinteger nullable
metadataobject nullable

Example response

{
  "tools": [
    {
      "filters": {
        "all": [
          {
            "key": "price",
            "operator": "gt",
            "value": "100"
          },
          {
            "key": "color",
            "operator": "eq",
            "value": "red"
          }
        ],
        "any": [
          {
            "key": "price",
            "operator": "gt",
            "value": "100"
          },
          {
            "key": "color",
            "operator": "eq",
            "value": "red"
          }
        ],
        "none": [
          {
            "key": "price",
            "operator": "gt",
            "value": "100"
          },
          {
            "key": "color",
            "operator": "eq",
            "value": "red"
          }
        ]
      }
    }
  ]
}