Skip to main content
GET
/
v1
/
retrievers
/
stages
List available retriever stages
curl --request GET \
  --url https://api.mixpeek.com/v1/retrievers/stages \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Namespace: <x-namespace>'
[
  {
    "category": "search",
    "description": "Performs semantic similarity search using dense vector embeddings",
    "icon": "brain-circuit",
    "parameter_schema": {
      "properties": {
        "feature_address": {
          "type": "string"
        },
        "limit": {
          "default": 10,
          "minimum": 1,
          "type": "integer"
        },
        "min_score": {
          "maximum": 1,
          "minimum": 0,
          "type": "number"
        }
      },
      "required": [
        "feature_address"
      ],
      "type": "object"
    },
    "stage_id": "semantic_search"
  }
]

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

​
stage_id
string
required

The unique identifier of the stage.

​
description
string
required

A description of what the stage does.

​
category
string
required

Category of the stage (search, reduce, rank, external, enrich, transform, compose).

​
icon
string
required

Lucide-react icon name for frontend rendering.

​
parameter_schema
object | null

The schema for the parameters this stage accepts.