Skip to main content
POST
/
v1
/
retrievers
/
list
List Retrievers
curl --request POST \
  --url https://api.mixpeek.com/v1/retrievers/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filters": {
    "retriever_name": {
      "$regex": "product_"
    }
  },
  "limit": 10,
  "offset": 0,
  "sorts": [
    {
      "direction": "desc",
      "field": "created_at"
    }
  ]
}'
{
  "pagination": {
    "has_more": false,
    "limit": 10,
    "skip": 0
  },
  "results": [
    {
      "collection_ids": [
        "col_products_v1"
      ],
      "metadata": {},
      "retriever_id": "ret_abc123",
      "retriever_name": "product_search_v1",
      "stages": []
    }
  ],
  "total_count": 1
}

Authorizations

​
Authorization
string
header
required

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.

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

The list retrievers request. List of retriever requests.

​
filters
object | null

Filters to apply when listing retrievers Represents a logical operation (AND, OR, NOT) on filter conditions.

Allows nesting with a defined depth limit.

Also supports shorthand syntax where field names can be passed directly as key-value pairs for equality filtering (e.g., {"metadata.title": "value"}).

​
sorts
SortOption · object[] | null

Sorting options for the retriever list

​
search
string | null

Search term for wildcard search across all text fields

​
case_sensitive
boolean
default:false

If True, filters and search will be case-sensitive

​
limit
integer
default:10

Pagination limit

Required range: 1 <= x <= 100
​
offset
integer
default:0

Pagination offset

Required range: x >= 0

Response

Successful Response

Response for listing retrievers.

​
results
RetrieverModel · object[]
required

List of retrievers matching the query

​
pagination
object
required

Pagination information for the current window

​
total_count
integer
required

Total number of retrievers that match the query

​
stats
object | null

Aggregate statistics across all retrievers in the result Aggregate statistics for a list of retrievers.

⌘I