Sign in

v5

latestOpenAPI 3.1.02026-08-04166362486.5 KB
responses

Create a response

Create a model response, optionally grounded in store search.

Supports the OpenAI Responses API subset: text input or item lists, function tools, conversation persistence via store and chaining via previous_response_id, and streaming via server-sent events. The Mixedbread hosted tools run server-side against the caller's stores and are all active by default: store_search (semantic search), store_grep (regular-expression match over chunk text), store_list_chunks (metadata filtering and ranking by a numeric metadata field), store_metadata_facets (the metadata keys and values available for filtering) and list_stores (paginated listing of the caller's stores with their connectors). Hosted tools are disabled by declaring them with enabled: false.

post/v1/responses

Request body

modelstring nullable

Accepted for OpenAI SDK compatibility and ignored; the platform selects the model

instructionsstring nullable

System instructions for this response

previous_response_idstring nullable

ID of a stored response to continue from

storeboolean

Whether to persist this response for later retrieval/chaining

streamboolean

Stream the response as server-sent events

temperaturenumber nullable
top_pnumber nullable
max_output_tokensinteger nullable
max_tool_callsinteger nullable

Maximum number of store search calls executed for this response

parallel_tool_callsboolean
metadataobject nullable
includestring[] nullable

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

Example request

{
  "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"
          }
        ]
      }
    }
  ]
}

Response

The generated response, or a server-sent event stream of response events

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"
          }
        ]
      }
    }
  ]
}