responses

Create a response

Changed on Sep 10, 2026

Create a text response with function and Mixedbread hosted-store tools.

post/v1/responses

Request

Base URL
https://api.mixedbread.com
URL
https://api.mixedbread.com/v1/responses
Auth
HTTP bearer

Request body

modelstring

instructionsstring nullable

storeboolean

previous_response_idstring nullable

streamboolean

temperaturenumber nullable

top_pnumber nullable

max_output_tokensinteger nullable

max_tool_callsinteger nullable

parallel_tool_callsboolean

metadataobject nullable

includestring[] nullable

backgroundboolean

truncation'auto' | 'disabled'

service_tier'auto' | 'default' | 'flex' | 'scale' | 'priority' nullable

safety_identifierstring nullable

prompt_cache_keystring nullable

userstring nullable

client_metadataobject nullable

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 semantic server-sent event stream

idstring required

object'response'

created_atnumber required

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

completed_atnumber nullable

instructionsstring nullable

modelstring

parallel_tool_callsboolean

temperaturenumber nullable

top_pnumber nullable

backgroundboolean

max_output_tokensinteger nullable

max_tool_callsinteger nullable

previous_response_idstring nullable

service_tier'auto' | 'default' | 'flex' | 'scale' | 'priority'

truncation'auto' | 'disabled'

metadataobject nullable

safety_identifierstring nullable

prompt_cache_keystring nullable

userstring nullable

titlestring nullable

Example response

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

Changes

Sep 10, 2026adde8ecfa74f Revision changes
- warning
  removed the request property ///
- warning
  removed the request property ///
- warning
  removed the request property ///
- warning
  removed the request property ///
- warning
  removed the request property ///
- warning
  removed the request property ///
- warning
  removed the request property ///
- warning
  removed the request property ///
- warning
  removed the optional property /// from the response with the status
- warning
  removed the optional property /// from the response with the status
- warning
  removed the optional property /// from the response with the status
- warning
  removed the optional property /// from the response with the status
- warning
  removed the optional property /// from the response with the status
- warning
  removed the optional property /// from the response with the status
- warning
  removed the optional property /// from the response with the status
- warning
  removed the optional property /// from the response with the status
Sep 5, 2026ea8d85b8caca Revision changes
- breaking
  added to the / response property oneOf list for the response status
- warning
  removed the optional property /// from the response with the status
- warning
  removed the optional property /// from the response with the status
- warning
  removed the optional property /// from the response with the status
- warning
  removed the optional property /// from the response with the status
- warning
  removed the optional property /// from the response with the status
- warning
  removed the optional property /// from the response with the status
- warning
  removed the optional property /// from the response with the status
- warning
  removed the optional property /// from the response with the status
- warning
  removed the optional property /// from the response with the status
- warning
  removed the optional property /// from the response with the status
- info
  added to the request property anyOf list
- info
  added mcp discriminator mapping keys to the / request property
- info
  added mcp_approval_request mcp_approval_response mcp_call mcp_list_tools discriminator mapping keys to the // request property
- info
  added to the / request property oneOf list
- info
  added to the // request property oneOf list
- info
  added to the / response property anyOf list for the response status
- info
  added to the response property anyOf list for the response status
- info
  added mcp_approval_request mcp_call mcp_list_tools discriminator mapping keys to the / response property for the response status

Operation history (10 revisions)