Sign in
latestOpenAPI 3.1.02026-08-22172405521.1 KB

6dac6bb49f72

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