Authorizations
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
REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.
"Bearer sk_live_abc123def456"
"Bearer sk_test_xyz789"
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'
"ns_abc123def456"
"production"
"my-namespace"
Path Parameters
Retriever ID or name.
Response
Successful Response
Retriever configuration model exposed via API.
Unique retriever name within namespace (REQUIRED).
1Collections queried by the pipeline (REQUIRED).
1Ordered list of stage configurations (REQUIRED).
1Stable retriever identifier (REQUIRED).
Detailed description of pipeline behaviour (OPTIONAL).
JSON Schema describing expected user inputs (REQUIRED). Properties must use BucketSchemaField for consistency with ingestion schemas.
Execution budget limits for the pipeline (OPTIONAL).
{ "max_credits": 100, "max_time_ms": 60000 }{ "max_time_ms": 120000 }Feature addresses required by stages (OPTIONAL, aids validation).
Arbitrary tags to help organise pipelines (OPTIONAL).
Creation timestamp in UTC (REQUIRED).
Last update timestamp in UTC (REQUIRED).
Identifier of the user who created the pipeline (OPTIONAL).
Identifier of the user who last updated the pipeline (OPTIONAL).

