Create a response

Create a response: one conversational turn of the Mixedbread agentic 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. Each turn runs the in-process search agent, which searches, greps, filters, and reads the caller's stores server-side as needed (reported as store_search_call, store_grep_call, and store_list_chunks_call output items) and can list the caller's stores via list_stores. A fresh conversation's bootstrap fetches are reported the same way: a store_metadata_facets_call for the initial facet inspection and a store_search_call for the seed search. The turn ends with the agent's submit_answer: an assistant message item carrying the evidence-grounded answer as output_text, followed by a sources item with the cited result chunks. The model's narration along the way arrives as intermediate reasoning items. Retrieval is active by default and scoped by the store-tool configurations; disable a tool by declaring it with enabled: false. A model call to a caller-declared function tool completes the response with function_call items; continue the conversation by sending the matching function_call_output items with previous_response_id, which resumes the persisted agent run exactly where it stopped.

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.