GET
/
v1
/
retrievers
/
stages
curl --request GET \
  --url https://api.mixpeek.com/v1/retrievers/stages
[
  {
    "stage_name": "<string>",
    "description": "<string>",
    "version": "<string>",
    "module_path": "<string>",
    "input_schema": {},
    "output_schema": {},
    "parameter_schema": {},
    "supported_input_types": [
      "<string>"
    ],
    "max_inputs": {},
    "default_parameters": {},
    "required_vector_indexes": [
      {
        "name": "<string>",
        "description": "<string>",
        "type": "single",
        "index": {
          "name": "<string>",
          "description": "<string>",
          "dimensions": 123,
          "type": "dense",
          "distance": "<string>"
        }
      }
    ],
    "required_payload_indexes": [
      "<any>"
    ],
    "supported_filters": [
      "<string>"
    ]
  }
]

Headers

​
Authorization
string | null

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. Example: 'Bearer sk_1234567890abcdef'

​
X-Namespace
string | null

Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.

Response

200
application/json
Successful Response
​
stage_name
string
required

Name of the stage

​
description
string
required
​
version
string
required
​
module_path
string
required
​
input_schema
object
required
​
output_schema
object
required
​
parameter_schema
object
required
​
supported_input_types
string[]
required
​
max_inputs
object
required
​
default_parameters
object
required
​
required_vector_indexes
object[] | null

Complete vector index definition that can be either single or multi-vector

​
required_payload_indexes
any[] | null
​
supported_filters
string[] | null

List of filter operations supported by this stage

Was this page helpful?

Suggest editsRaise issue