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

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"

Path Parameters

​
retriever_id
string
required

Retriever ID or name.

Response

Successful Response

Retriever configuration model exposed via API.

​
retriever_name
string
required

Unique retriever name within namespace (REQUIRED).

Minimum length: 1
​
collection_ids
string[]
required

Collections queried by the retriever (REQUIRED).

Minimum length: 1
​
stages
StageConfig · object[]
required

Ordered list of stage configurations (REQUIRED).

Minimum length: 1
​
retriever_id
string

Stable retriever identifier (REQUIRED).

​
description
string | null

Detailed description of retriever behaviour (OPTIONAL).

​
input_schema
object

JSON Schema describing expected user inputs (REQUIRED). Properties must use BucketSchemaField for consistency with ingestion schemas.

​
budget_limits
object

Execution budget limits for the retriever (OPTIONAL).

Examples:
{ "max_credits": 100, "max_time_ms": 60000 }
{ "max_time_ms": 120000 }
​
feature_dependencies
FeatureAddress · object[] | null

Feature addresses required by stages (OPTIONAL, aids validation).

​
tags
string[]

Arbitrary tags to help organise retrievers (OPTIONAL).

​
created_at
string<date-time>

Creation timestamp in UTC (REQUIRED).

​
updated_at
string<date-time>

Last update timestamp in UTC (REQUIRED).

​
created_by
string | null

Identifier of the user who created the retriever (OPTIONAL).

​
updated_by
string | null

Identifier of the user who last updated the retriever (OPTIONAL).