Skip to main content
POST
/
v1
/
retrievers
/
list
List Retrievers
curl --request POST \
  --url https://api.mixpeek.com/v1/retrievers/list \
  --header 'Content-Type: application/json' \
  --data '
{
  "search": "<string>",
  "filters": {},
  "sorts": [
    {}
  ],
  "case_sensitive": false
}
'
{
  "results": [
    {
      "retriever_name": "<string>",
      "stages": [
        {
          "stage_name": "<string>",
          "config": {},
          "stage_type": "filter",
          "batch_size": "<string>",
          "description": "<string>"
        }
      ],
      "retriever_id": "<string>",
      "description": "<string>",
      "collection_ids": [
        "<string>"
      ],
      "input_schema": {},
      "budget_limits": {
        "max_credits": 1,
        "max_time_ms": 1
      },
      "feature_dependencies": [
        {
          "extractor": "<string>",
          "version": "<string>",
          "scheme": "mixpeek",
          "output": "<string>"
        }
      ],
      "tags": [
        "<string>"
      ],
      "display_config": {},
      "version": 1,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "updated_by": "<string>",
      "is_published": false
    }
  ],
  "total": 0
}

Headers

​
Authorization
string

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_API_KEY"

​
X-Namespace
string

REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Query Parameters

​
limit
integer | null
Required range: 1 <= x <= 1000
​
offset
integer | null
Required range: 0 <= x <= 10000
​
cursor
string | null
​
include_total
boolean
default:false

Body

application/json

Request to list retrievers.

​
search
string | null

Search term for wildcard search across retriever_id, retriever_name, description, and other text fields

​
filters
Filters · object

Filters to apply to the retriever list. Supports filtering by retriever_id or retriever_name.

​
sorts
Sorts · object[] | null

Sort options for the retriever list

​
case_sensitive
boolean
default:false

If True, filters and search will be case-sensitive

Response

Successful Response

Response from listing retrievers.

​
results
RetrieverModel · object[]

List of retrievers in the namespace.

​
total
integer
default:0

Total number of retrievers.