Mixpeek API (Multimodal Search)

Get detailed information about a specific feature extractor by its name

List all available feature extractors grouped by category

Discover all available feature extractors with their capabilities, supported modalities, output features, and example usage. Use this to understand what extractors are available when configuring namespaces and collections in manifests.

Returns combined discovery information including extractors, stages, and manifest schema in a single request. Use this for comprehensive capability discovery.

Returns the complete manifest schema including all resource types, their JSON schemas, dependency graph, and YAML examples. Use this for programmatic manifest generation and validation.

Discover all available retriever stages with extended information including example configurations, common use cases, and cost tiers. This endpoint provides more context than /v1/retrievers/stages for agent-driven configuration.

Check if Celery Beat scheduler is running. Reads the heartbeat timestamp from Redis (written every 60s by beat). Returns unhealthy if heartbeat is older than 5 minutes.

Browse marketplace catalog with optional filters. Returns all published, active marketplace listings. Free tier is always available.

Get display configuration for public page rendering. ⚠️ DEPRECATED: Use `/v1/marketplace/catalog/{public_name}/config` instead. This endpoint is maintained for backwards compatibility but may be removed in the future. Returns the UI configuration needed to render the public search interface. Used by the frontend app at mxp.co to dynamically build the UI. Authentication: - NO authentication required - this endpoint is public - Anyone can access the config if they know the public_name - The config includes the public_api_key needed for execute/interact endpoints Response includes: - Display config (logo, theme, components, field rendering) - Title and description - Password protection status - Public API key for subsequent authenticated requests Example (deprecated): ```bash curl -X GET "https://api.mixpeek.com/v1/public/retrievers/video-search/config" ``` Example (recommended): ```bash curl -X GET "https://api.mixpeek.com/v1/marketplace/catalog/video-search/config" ```

List all public retrievers with pagination and search. This endpoint allows browsing and discovering all published retrievers across all organizations. No authentication required. Authentication: - NO authentication required - completely public endpoint - Discover retrievers created by all Mixpeek users Pagination: - Default: page=1, page_size=20 - Maximum page_size: 100 - Returns total count and total pages Search: - Search across retriever titles and descriptions - Case-insensitive regex matching - Combine with pagination Filtering: - By default, only active retrievers are shown - Set `include_inactive=true` to see all retrievers Response includes: - List of public retrievers with basic info - Pagination details (page, page_size, total_count, total_pages) - Aggregate statistics (total active, password protected, open) What's NOT exposed: - API keys (except in individual config endpoint) - Internal IDs or organization details - Full retriever configuration (use template endpoint for that) - Password values (only password_protected: true/false) Example: ```bash # List all public retrievers (first page) curl -X GET "https://api.mixpeek.com/v1/public/retrievers/" # Search for video-related retrievers curl -X GET "https://api.mixpeek.com/v1/public/retrievers/?search=video&page_size=50" # Get page 2 with custom page size curl -X GET "https://api.mixpeek.com/v1/public/retrievers/?page=2&page_size=50" ``` Use Cases: - Browse available public retrievers - Discover search patterns and implementations - Find retrievers to use as templates - Explore what others have built

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)

List public namespace templates (no authentication required). Returns only templates marked as public (is_public=True).

List public retriever templates (no authentication required). Returns only templates marked as public (is_public=True).

Get public retriever template details (no authentication required). Returns template only if marked as public.

List available scaffold templates (public, no auth required). Scaffolds are pre-configured templates that create complete infrastructure: - Namespace with feature extractors - Bucket with data schema - Collection with processing config - Retriever with search pipeline Categories: - `media` - Video, image, podcast search - `documents` - Document Q&A, RAG - `ecommerce` - Product catalog search To instantiate (requires auth): ``` POST /v1/templates/scaffolds/{template_id}/instantiate {"namespace_name": "my_app"} ```

List all registered retriever stages with their configurations. Use this endpoint to discover available stages before creating retrievers. Each stage includes its ID, description, category, and full parameter schema. The parameter_schema field contains complete Pydantic JSON Schema with validation rules, descriptions, and examples for all stage parameters.