POST
/
v1
/
retrievers
/
retrievers
curl --request POST \
  --url https://api.mixpeek.com/v1/retrievers/retrievers \
  --header 'Content-Type: application/json' \
  --data '{
  "retriever_name": "<string>",
  "description": "<string>",
  "input_schema": {
    "properties": {}
  },
  "collection_ids": [
    "<string>"
  ],
  "stages": [
    {
      "stage_name": "<string>",
      "version": "<string>",
      "module_path": "<string>",
      "parameters": {},
      "pre_filters": {
        "AND": [
          {
            "field": "name",
            "operator": "eq",
            "value": "John"
          },
          {
            "field": "age",
            "operator": "gte",
            "value": 30
          }
        ],
        "OR": [
          {
            "field": "status",
            "operator": "eq",
            "value": "active"
          },
          {
            "field": "role",
            "operator": "eq",
            "value": "admin"
          }
        ],
        "NOT": [
          {
            "field": "department",
            "operator": "eq",
            "value": "HR"
          },
          {
            "field": "location",
            "operator": "eq",
            "value": "remote"
          }
        ],
        "case_sensitive": true
      },
      "post_filters": {
        "AND": [
          {
            "field": "name",
            "operator": "eq",
            "value": "John"
          },
          {
            "field": "age",
            "operator": "gte",
            "value": 30
          }
        ],
        "OR": [
          {
            "field": "status",
            "operator": "eq",
            "value": "active"
          },
          {
            "field": "role",
            "operator": "eq",
            "value": "admin"
          }
        ],
        "NOT": [
          {
            "field": "department",
            "operator": "eq",
            "value": "HR"
          },
          {
            "field": "location",
            "operator": "eq",
            "value": "remote"
          }
        ],
        "case_sensitive": true
      },
      "timeout_seconds": 123,
      "exclude_from_final": false
    }
  ],
  "metadata": {},
  "cache_config": {
    "enabled": true,
    "ttl_seconds": 123,
    "score_threshold": 123
  }
}'
{
  "retriever_id": "<string>",
  "retriever_name": "<string>",
  "description": "<string>",
  "input_schema": {
    "properties": {}
  },
  "collection_ids": [
    "<string>"
  ],
  "stages": [
    {
      "stage_name": "<string>",
      "version": "<string>",
      "module_path": "<string>",
      "parameters": {},
      "pre_filters": {
        "AND": [
          {
            "field": "name",
            "operator": "eq",
            "value": "John"
          },
          {
            "field": "age",
            "operator": "gte",
            "value": 30
          }
        ],
        "OR": [
          {
            "field": "status",
            "operator": "eq",
            "value": "active"
          },
          {
            "field": "role",
            "operator": "eq",
            "value": "admin"
          }
        ],
        "NOT": [
          {
            "field": "department",
            "operator": "eq",
            "value": "HR"
          },
          {
            "field": "location",
            "operator": "eq",
            "value": "remote"
          }
        ],
        "case_sensitive": true
      },
      "post_filters": {
        "AND": [
          {
            "field": "name",
            "operator": "eq",
            "value": "John"
          },
          {
            "field": "age",
            "operator": "gte",
            "value": 30
          }
        ],
        "OR": [
          {
            "field": "status",
            "operator": "eq",
            "value": "active"
          },
          {
            "field": "role",
            "operator": "eq",
            "value": "admin"
          }
        ],
        "NOT": [
          {
            "field": "department",
            "operator": "eq",
            "value": "HR"
          },
          {
            "field": "location",
            "operator": "eq",
            "value": "remote"
          }
        ],
        "case_sensitive": true
      },
      "timeout_seconds": 123,
      "exclude_from_final": false
    }
  ],
  "metadata": {},
  "cache_config": {
    "enabled": true,
    "ttl_seconds": 123,
    "score_threshold": 123
  }
}

Headers

​
Authorization
string | null

Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings. Example: 'Bearer sk_1234567890abcdef'

​
X-Namespace
string | null

Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.

Body

application/json

Request to create a new retriever

​
retriever_name
string
required

Name of the retriever

​
input_schema
object
required

Schema defining the expected input format

​
collection_ids
string[]
required

List of collection IDs to search in

​
stages
object[]
required

List of stages to execute in order

Configuration for how a retriever stage processes queries and handles results.

This model consolidates stage-specific settings that control behavior during retrieval operations, making it easier to configure stages with consistent options.

​
description
string | null

Description of the retriever

​
metadata
object
​
cache_config
object | null

Configuration for retriever-level caching

Response

200
application/json
Successful Response

Definition of a retriever

​
retriever_name
string
required

Name of the retriever

​
input_schema
object
required

Schema defining the expected input format

​
collection_ids
string[]
required

List of collection IDs to search in

​
stages
object[]
required

List of stages to execute in order

Configuration for how a retriever stage processes queries and handles results.

This model consolidates stage-specific settings that control behavior during retrieval operations, making it easier to configure stages with consistent options.

​
retriever_id
string

Unique identifier for the retriever

​
description
string | null

Description of the retriever

​
metadata
object
​
cache_config
object | null

Configuration for retriever-level caching