Get Public Retriever Template
Get retriever configuration as a reusable template. Returns the published retriever's configuration in a format that can be directly used to create your own retriever. This is perfect for discovering patterns and adapting them to your own data. Authentication: - NO authentication required - this endpoint is completely public - Anyone can get the template if they know the public_name Use Case: 1. Browse public retrievers to find patterns you like 2. GET this endpoint to get the full configuration 3. Copy the config and modify for your needs (especially `collection_identifiers`) 4. POST to `/v1/retrievers` to create your own retriever 5. Optionally publish it with the same display_config What's included: - Retriever configuration (stages, input_schema, budget_limits) - Display configuration (for publishing with similar UI) - Original metadata for reference What you need to change: - `collection_identifiers`: Replace with your own collection IDs - `retriever_name`: Give it a unique name - Optionally modify stages, inputs, display_config as needed Example: ```bash # 1. Get the template curl -X GET "https://api.mixpeek.com/v1/public/retrievers/video-search/template" # 2. Modify the response and create your own retriever curl -X POST "https://api.mixpeek.com/v1/retrievers" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "retriever_name": "my_video_search", "collection_identifiers": ["my_videos"], "stages": [...], # From template "input_schema": {...}, # From template "budget_limits": {...}, # From template "display_config": {...} # From template (optional) }' ``` Response includes: - All retriever configuration fields - Display config for publishing (optional to use) - Source reference (where this template came from)
Call setup
mixpeek.public.retrievers.template.retrieve.v1.358d069f