responses

Create a response

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

post/v1/responses

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

Changed in 7 of the 17 revisions of this API.1037

Aug 19, 2026f66774ddecfc1See the full diff
- ○
  endpoint added
  endpoint-added
Aug 13, 2026d47e1d8525491See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 35 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 12, 2026ff7d87258f3213See the full diff
- ▲
  added to the / response property oneOf list for the response status
  response-property-one-of-added
- ○
  added reasoning sources discriminator mapping keys to the // request property
  request-property-discriminator-mapping-added
- ○
  added to the // request property oneOf list
  request-property-one-of-added
- ○
  added reasoning sources discriminator mapping keys to the / response property for the response status
  response-property-discriminator-mapping-added
Aug 4, 20262eece97b5ae5311See the full diff
- ▲
  removed from the // request property oneOf list
  request-property-one-of-removed
- ▲
  added to the / response property oneOf list for the response status
  response-property-one-of-added
- ▲
  added to the / response property oneOf list for the response status
  response-property-one-of-added
- ○
  added to the request property anyOf list
  request-property-any-of-added
- ○
  added store_grep store_list_chunks store_metadata_facets discriminator mapping keys to the / request property
  request-property-discriminator-mapping-added
- ○
  added store_grep_call store_list_chunks_call store_metadata_facets_call discriminator mapping keys to the // request property
  request-property-discriminator-mapping-added
- ○
  mapped value for discriminator key store_search_call changed from to for // request property
  request-property-discriminator-mapping-changed
- ○
  added to the / request property oneOf list
  request-property-one-of-added
- ○
  added to the // request property oneOf list
  request-property-one-of-added
- ○
  added to the response property anyOf list for the response status
  response-property-any-of-added
- ○
  added store_grep store_list_chunks store_metadata_facets discriminator mapping keys to the / response property for the response status
  response-property-discriminator-mapping-added
- ○
  added store_grep_call store_list_chunks_call store_metadata_facets_call discriminator mapping keys to the / response property for the response status
  response-property-discriminator-mapping-added
- ○
  mapped value for discriminator key store_search_call changed from to for / response property for the response status
  response-property-discriminator-mapping-changed
- ○
  removed from the / response property oneOf list for the response status
  response-property-one-of-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 1, 2026d13e684fd1c92See the full diff
- ○
  added the new optional request property ///////
  new-optional-request-property
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
Jul 31, 2026c6cc661737c3519See the full diff
- ▲
  the response property /// became optional for the status
  response-property-became-optional
- ▲
  response property tools/items/oneOf[subschema #1: StoreSearchTool]/store_identifiers list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  added to the ///// response property oneOf list for the response status
  response-property-one-of-added
- ▲
  added to the / response property oneOf list for the response status
  response-property-one-of-added
- ▲
  added to the / response property oneOf list for the response status
  response-property-one-of-added
- ○
  added the new optional request property ////
  new-optional-request-property
- ○
  added the new optional request property ////
  new-optional-request-property
- ○
  added the new optional request property ///
  new-optional-request-property
- ○
  added to the request property anyOf list
  request-property-any-of-added
- ○
  the request property /// became optional
  request-property-became-optional
- ○
  added input_file input_image discriminator mapping keys to the ////// request property
  request-property-discriminator-mapping-added
- ○
  added list_stores discriminator mapping keys to the / request property
  request-property-discriminator-mapping-added
- ○
  added list_stores_call discriminator mapping keys to the // request property
  request-property-discriminator-mapping-added
- ○
  request property /// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  added to the ////// request property oneOf list
  request-property-one-of-added
- ○
  added to the // request property oneOf list
  request-property-one-of-added
- ○
  added to the / request property oneOf list
  request-property-one-of-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added to the response property anyOf list for the response status
  response-property-any-of-added
- ○
  added input_file input_image discriminator mapping keys to the ///// response property for the response status
  response-property-discriminator-mapping-added
- ○
  added list_stores discriminator mapping keys to the / response property for the response status
  response-property-discriminator-mapping-added
- ○
  added list_stores_call discriminator mapping keys to the / response property for the response status
  response-property-discriminator-mapping-added
Jul 26, 2026587cbdf607b01See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog