Skip to main content
GET
/
v1
/
retrievers
List Retrievers
curl --request GET \
  --url https://api.mixpeek.com/v1/retrievers \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Namespace: <x-namespace>'
{
  "retrievers": [
    {
      "budget_limits": {
        "max_credits": 100,
        "max_time_ms": 60000
      },
      "collection_ids": [
        "col_marketing_ads"
      ],
      "input_schema": {
        "query_text": {
          "description": "Full-text query",
          "type": "string"
        }
      },
      "name": "executive_ads_search",
      "pipeline_id": "pipe_abc123",
      "stages": [
        {
          "config": {
            "parameters": {
              "field": "metadata.spend",
              "operator": "gt",
              "value": 1000
            },
            "stage_name": "attribute_filter",
            "version": "v1"
          },
          "name": "filter_high_spend",
          "stage_type": "filter"
        }
      ]
    }
  ],
  "total": 0
}

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
required

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 sk_live_abc123def456"

"Bearer sk_test_xyz789"

​
X-Namespace
string
required

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"

Response

Successful Response

Response from listing retrievers.

​
retrievers
RetrieverModel · object[]

List of retrievers in the namespace.

​
total
integer
default:0

Total number of retrievers.