Skip to main content
GET
/
v1
/
retrievers
/
{retriever_id}
Get Retriever
curl --request GET \
  --url https://api.mixpeek.com/v1/retrievers/{retriever_id}
{
  "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
}

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"

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 string length: 1
​
stages
StageConfig · object[]
required

Ordered list of stage configurations (REQUIRED).

Minimum array length: 1
​
retriever_id
string

Stable retriever identifier (REQUIRED).

​
description
string | null

Detailed description of retriever behaviour (OPTIONAL).

​
collection_ids
string[]

Collections queried by the retriever. Can be empty for query-only inference mode.

​
input_schema
Input Schema · object

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

​
budget_limits
BudgetLimits · 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).

​
display_config
Display Config · object

Display configuration for public retriever UI rendering (OPTIONAL). Defines how the search interface should appear when the retriever is published, including input fields, theme, layout, exposed result fields, and field formatting. This configuration is used as the default when publishing the retriever.

​
version
integer
default:1

Version number that increments on each update (REQUIRED).

Required range: x >= 1
​
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).

​
is_published
boolean
default:false

Whether this retriever is currently published as a public API