POST
/
v1
/
retrievers
/
list
List Retrievers
curl --request POST \
  --url https://api.mixpeek.com/v1/retrievers/list \
  --header 'Content-Type: application/json' \
  --data '{
  "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
  },
  "sorts": [
    {
      "field": "created_at",
      "direction": "desc"
    }
  ],
  "limit": 10,
  "offset": 0
}'
{
  "results": [
    {
      "retriever_id": "<string>",
      "retriever_name": "<string>",
      "description": "<string>",
      "input_schema": {
        "properties": {}
      },
      "collection_ids": [
        "<string>"
      ],
      "stages": [
        {
          "stage_name": "<string>",
          "version": "<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
          }
        }
      ]
    }
  ],
  "pagination": {}
}

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.

Query Parameters

​
limit
integer | null
​
offset
integer | null

Body

application/json

The list retrievers request. List of retriever requests.

Response

200
application/json

Successful Response

Response for listing retrievers.