Health
Namespaces
Buckets
Feature Extractors
Collections
Retrievers
Taxonomies
Clusters
Templates
Analytics
Resource Search
Inference
Agent Sessions
Notifications
curl --request GET \
--url https://api.mixpeek.com/v1/public/retrievers/{public_name}/config \
--header 'Authorization: Bearer <token>'{
"public_name": "<string>",
"public_api_key": "<string>",
"display_config": {
"title": "<string>",
"inputs": [
{
"field_name": "<string>",
"field_schema": {
"type": "string",
"default": "<unknown>",
"items": "<unknown>",
"properties": {},
"examples": [
"<unknown>"
],
"description": "<string>",
"enum": [
"<unknown>"
],
"required": false
},
"label": "<string>",
"placeholder": "Enter search terms...",
"helper_text": "Describe the aesthetic, outfit, or vibe you're looking for",
"suggestions": [
"streetwear urban",
"clean girl minimal",
"summer haul bright"
],
"required": true,
"order": 0
}
],
"exposed_fields": [
"<string>"
],
"description": "Search through thousands of products",
"logo_url": "https://example.com/logo.png",
"og_image_url": "https://s3.amazonaws.com/mixpeek-server-dev/org123/ns456/public-retriever-og-images/video-search/og.png",
"markdowns": [
{
"title": "<string>",
"content": "<string>"
}
],
"theme": {
"primary_color": "#007AFF",
"secondary_color": "#FF6B6B",
"font_family": "system-ui, -apple-system, sans-serif",
"background_color": "#FFFFFF",
"text_color": "#000000"
},
"layout": {
"mode": "grid",
"columns": 3,
"gap": "16px"
},
"components": {
"show_search": true,
"show_filters": false,
"result_layout": "grid",
"result_card": {
"layout": "vertical",
"show_thumbnail": true,
"thumbnail_aspect_ratio": "16/9",
"thumbnail_fit": "cover",
"show_score": false,
"truncate_title": 60,
"truncate_description": 120,
"field_order": [
"<string>"
]
}
},
"field_config": {}
},
"password_protected": true,
"retriever_metadata": {
"stages": [
{}
],
"collections": [
{}
],
"capabilities": {}
}
}Get Public Retriever Config
Get display configuration for public page rendering.
Returns the UI configuration needed to render the public search interface. Used by the frontend app at apps.mixpeek.com 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:
curl -X GET "https://api.mixpeek.com/v1/public/retrievers/video-search/config"
curl --request GET \
--url https://api.mixpeek.com/v1/public/retrievers/{public_name}/config \
--header 'Authorization: Bearer <token>'{
"public_name": "<string>",
"public_api_key": "<string>",
"display_config": {
"title": "<string>",
"inputs": [
{
"field_name": "<string>",
"field_schema": {
"type": "string",
"default": "<unknown>",
"items": "<unknown>",
"properties": {},
"examples": [
"<unknown>"
],
"description": "<string>",
"enum": [
"<unknown>"
],
"required": false
},
"label": "<string>",
"placeholder": "Enter search terms...",
"helper_text": "Describe the aesthetic, outfit, or vibe you're looking for",
"suggestions": [
"streetwear urban",
"clean girl minimal",
"summer haul bright"
],
"required": true,
"order": 0
}
],
"exposed_fields": [
"<string>"
],
"description": "Search through thousands of products",
"logo_url": "https://example.com/logo.png",
"og_image_url": "https://s3.amazonaws.com/mixpeek-server-dev/org123/ns456/public-retriever-og-images/video-search/og.png",
"markdowns": [
{
"title": "<string>",
"content": "<string>"
}
],
"theme": {
"primary_color": "#007AFF",
"secondary_color": "#FF6B6B",
"font_family": "system-ui, -apple-system, sans-serif",
"background_color": "#FFFFFF",
"text_color": "#000000"
},
"layout": {
"mode": "grid",
"columns": 3,
"gap": "16px"
},
"components": {
"show_search": true,
"show_filters": false,
"result_layout": "grid",
"result_card": {
"layout": "vertical",
"show_thumbnail": true,
"thumbnail_aspect_ratio": "16/9",
"thumbnail_fit": "cover",
"show_score": false,
"truncate_title": 60,
"truncate_description": 120,
"field_order": [
"<string>"
]
}
},
"field_config": {}
},
"password_protected": true,
"retriever_metadata": {
"stages": [
{}
],
"collections": [
{}
],
"capabilities": {}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Public name of the published retriever
Response
Successful Response
Response for fetching public retriever configuration (for UI rendering).
This is what the public frontend (apps.mixpeek.com) fetches to render the search interface. It includes everything needed for UI rendering.
Public name of the retriever
Public API key for making authenticated requests. Frontend needs this to call the execute endpoint.
Display configuration for rendering the UI. Includes inputs, theme, layout, and exposed fields.
Show child attributes
Show child attributes
Title/heading for the public search page
List of input fields to render in the search interface. Each input maps to a field in the retriever's input_schema. Frontend uses the field_schema to render the appropriate component type.
1Show child attributes
Show child attributes
Name of the input field (matches retriever input_schema key)
Schema definition for this input field. Defines type, description, examples, and validation rules. Frontend uses this to render the appropriate input component (text input, image upload, dropdown, etc.)
Show child attributes
Show child attributes
Supported data types for bucket schema fields.
Types fall into two categories:
-
Explicit Types (Type-Safe):
- Provide type guarantees for extractors
- User must pre-classify content
- Compatible with type-specific extractors
-
Automatic Type (Flexible):
- No type guarantee (runtime detection)
- User doesn't pre-classify content
- Only compatible with multimodal extractors
string, number, integer, float, boolean, object, array, date, datetime, json, file, text, image, audio, video, pdf, document, spreadsheet, presentation, dense_vector, sparse_vector, int8_vector, automatic OPTIONAL. List of example values for this field. Used by Apps to show example inputs in the UI. Provide multiple diverse examples when possible.
Human-readable label for the input
Placeholder text for the input
"Enter search terms..."
Helper text displayed below the input to guide users
"Describe the aesthetic, outfit, or vibe you're looking for"
Pre-filled suggestion chips that users can click to populate the input
[
"streetwear urban",
"clean girl minimal",
"summer haul bright"
]Whether this input is required
Display order (lower numbers appear first)
x >= 0List of document metadata fields to show in results. Only these fields are returned to end users.
1Optional description/subtitle for the page
"Search through thousands of products"
URL to logo image
"https://example.com/logo.png"
URL to auto-generated social preview/OG image
"https://s3.amazonaws.com/mixpeek-server-dev/org123/ns456/public-retriever-og-images/video-search/og.png"
Array of markdown content sections for documentation, guides, or informational modals. Each section has a title and markdown-formatted content. Displayed in modals, expandable sections, or tabs on the public interface. Examples: 'How it Works', 'Search Guide', 'About', 'FAQ', etc.
Show child attributes
Show child attributes
Title for the markdown content section
1 - 200Markdown-formatted content. Supports standard markdown syntax including headers, lists, links, images, code blocks, and emphasis. Limited to 50KB to prevent database issues.
1 - 50000Theme/styling configuration
Show child attributes
Show child attributes
Primary brand color (hex code)
Secondary/accent color (hex code)
"#FF6B6B"
Font family for text
Background color (hex code)
Primary text color (hex code)
Configuration for UI components including search inputs, filters, and result card display options.
Show child attributes
Show child attributes
Whether to show search input fields
Whether to show filters sidebar
Layout mode for results display
Configuration for result card display
Show child attributes
Show child attributes
Card layout orientation
Whether to show thumbnail image in results
Aspect ratio for thumbnail images
How thumbnail should fit in container
Whether to display relevance score
Maximum characters for title before truncation
x >= 160
Maximum characters for description before truncation
x >= 1120
Order of fields to display in result card. Fields not in this list won't be shown. Must be subset of exposed_fields.
Configuration for how each field should be displayed. Keys are field names (must be subset of exposed_fields). Values are FieldConfig objects specifying format and display options.
Show child attributes
Show child attributes
Configuration for how to display a specific field in results.
Show child attributes
Show child attributes
Format type for this field (text, image, date, number, etc.)
text, image, date, number, url, boolean, array, object Format-specific display options
Show child attributes
Show child attributes
Display label for this field
"Title"
Whether to show the field if value is empty/null
Maximum characters before truncation (for text fields)
x >= 160
Image width in pixels
x >= 1400
Image height in pixels
x >= 1300
Enable lazy loading for images (default: true)
Aspect ratio for image container
"16/9"
CSS object-fit property for images
Date format type: 'iso', 'relative', or custom format string
Number of decimal places
x >= 00
Prefix for number display
"$"
Suffix for number display
"%"
Open URLs in new tab (default: true)
Show domain instead of full URL
Label for true values
Label for false values
Separator for array items (default: ', ')
Maximum array items to display
x >= 1Whether this retriever requires password authentication
OPTIONAL. Technical metadata about how the retriever works. Only present if include_metadata=True was set during publishing.
Was this page helpful?