Retrievers
List Retrievers Get
Changed onList all retrievers in the namespace (GET alias for POST /list).
get/v1/retrievers
Request
- Base URL: https://api.mixpeek.com
- URL: https://api.mixpeek.com/v1/retrievers
- Auth: HTTP bearer and API key in header X-Namespace
Query parameters
limitinteger nullable
page_sizeinteger nullable
offsetinteger nullable
pageinteger nullable
cursorstring nullable
next_cursorstring nullable
afterstring nullable
include_totalboolean
Response
Successful Response
Example response
{
"results": [
{
"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_id": "attribute_filter"
},
"stage_name": "filter_high_spend",
"stage_type": "filter"
}
]
}
],
"warnings": [
{
"resource": "taxonomy",
"id": "tax_abc123",
"reason": "not found in namespace",
"next_step": "Fix the taxonomy_id on the stage, or create the taxonomy."
}
]
}Changes
- warning
removed the optional property
from the response with the status - info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the optional property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status
- warning
- info
added the optional property
to the response with the status
- info