Skip to main content
GET
/
v1
/
retrievers
/
{retriever_id}
/
publish
Get Published Retriever
curl --request GET \
  --url https://api.mixpeek.com/v1/retrievers/{retriever_id}/publish
{
  "retriever_id": "<string>",
  "public_id": "<string>",
  "public_name": "<string>",
  "display_config": {
    "title": "<string>",
    "inputs": [
      {
        "field_name": "<string>",
        "field_schema": {
          "type": "string",
          "default": null,
          "items": null,
          "properties": {},
          "examples": [
            "<unknown>"
          ],
          "description": "<string>",
          "enum": [
            "<unknown>"
          ],
          "required": false
        },
        "label": "<string>",
        "input_type": "text",
        "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",
    "icon_base64": "data:image/png;base64,iVBORw0KGgoAAAANS...",
    "seo": {
      "author": "Mixpeek",
      "favicon_url": "https://example.com/favicon.ico",
      "keywords": [
        "fitness",
        "yoga",
        "workout",
        "exercise videos"
      ],
      "locale": "en_US",
      "logo_url": "https://example.com/logo.png",
      "meta_description": "Search and discover fitness videos using AI-powered semantic search.",
      "meta_title": "Fitness Video Search | Mixpeek",
      "og_image_alt": "Fitness video search interface",
      "og_image_url": "https://mixpeek-public-pages.s3.amazonaws.com/og.png",
      "og_type": "website",
      "robots": "index, follow",
      "site_name": "Mixpeek",
      "structured_data": {
        "additional_properties": {
          "applicationCategory": "Search"
        },
        "type": "WebApplication"
      },
      "twitter_card": "summary_large_image",
      "twitter_site": "@mixpeek"
    },
    "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": "#374151",
      "heading_font_family": "Georgia, serif",
      "surface_color": "#F9FAFB",
      "muted_color": "#6B7280",
      "border_color": "#E5E7EB",
      "border_radius": "8px",
      "card_style": "elevated",
      "card_hover_effect": "lift"
    },
    "layout": {
      "mode": "grid",
      "columns": 3,
      "gap": "16px",
      "full_width": false
    },
    "components": {
      "show_hero": true,
      "show_search": true,
      "show_filters": false,
      "show_results_header": true,
      "result_layout": "grid",
      "result_card": {
        "card_click_action": "viewDetails",
        "card_style": "default",
        "field_order": [
          "title",
          "description",
          "category",
          "created_at"
        ],
        "layout": "vertical",
        "show_find_similar": true,
        "show_score": true,
        "show_thumbnail": true,
        "thumbnail_aspect_ratio": "16/9",
        "thumbnail_field": "image_url",
        "thumbnail_fit": "cover",
        "title_field": "title",
        "truncate_description": 120,
        "truncate_title": 60
      }
    },
    "field_config": {},
    "custom_cta": {
      "label": "Search Tips",
      "markdown_content": "# Search Tips\n\n- Use quotes for exact phrases\n- Filter by date using 'after:2024'"
    },
    "external_links": [
      {
        "name": "<string>",
        "url": "<string>"
      }
    ],
    "template_type": "portrait-gallery",
    "field_mappings": {
      "boundingBox": "ocr_bbox",
      "extractedText": "ocr_text",
      "thumbnail": "page_thumbnail_url",
      "title": "document_title"
    },
    "extensions": {
      "show_timestamps": true,
      "video_autoplay": true
    },
    "retriever_config": {}
  },
  "rate_limit_config": {
    "enabled": true,
    "tier": "standard",
    "requests_per_minute": 2,
    "requests_per_hour": 2,
    "requests_per_day": 2,
    "max_results_per_query": 100,
    "enable_ip_limits": false,
    "max_requests_per_ip_hour": 2
  },
  "password_protected": true,
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "icon_base64": "<string>",
  "public_api_key": "<string>",
  "retriever_metadata": {
    "stages": [
      {}
    ],
    "collections": [
      {}
    ],
    "capabilities": {}
  },
  "tags": [
    "<string>"
  ],
  "category": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_API_KEY"

​
authorization
string
​
X-Namespace
string

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'. Falls back to ?namespace= query parameter if the header is omitted.

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Path Parameters

​
retriever_id
string
required

ID of the retriever

Response

Successful Response

Response model for GET published retriever.

Returns the full published retriever config including the public API key since the user already has access to it.

​
retriever_id
string
required

ID of the underlying retriever

​
public_id
string
required

Public identifier for this published retriever

​
public_name
string
required

Public URL-safe name

​
display_config
DisplayConfig · object
required

Display configuration for UI rendering

Example:
{
  "components": {
    "result_card": {
      "card_click_action": "viewDetails",
      "field_order": ["title", "description", "price"],
      "layout": "vertical",
      "show_find_similar": true,
      "show_thumbnail": true
    },
    "result_layout": "grid",
    "show_hero": true,
    "show_results_header": true,
    "show_search": true
  },
  "custom_cta": {
    "label": "Search Tips",
    "markdown_content": "# Search Tips\n\n- Use quotes for exact phrases\n- Try descriptive terms"
  },
  "description": "Search through our product catalog",
  "exposed_fields": [
    "title",
    "description",
    "price",
    "image_url"
  ],
  "external_links": [
    {
      "name": "GitHub Repository",
      "url": "https://github.com/mixpeek/product-search"
    },
    {
      "name": "Blog Post",
      "url": "https://blog.mixpeek.com/building-product-search"
    }
  ],
  "field_config": {
    "price": {
      "format": "number",
      "format_options": {
        "decimals": 2,
        "label": "Price",
        "prefix": "$"
      }
    },
    "title": {
      "format": "text",
      "format_options": {
        "label": "Product Name",
        "truncate_chars": 60
      }
    }
  },
  "field_mappings": {
    "thumbnail": "image_url",
    "title": "title"
  },
  "inputs": [
    {
      "field_name": "query",
      "field_schema": {
        "description": "Search query",
        "examples": ["wireless headphones", "laptop"],
        "type": "string"
      },
      "input_type": "text",
      "label": "Search Products",
      "order": 0,
      "placeholder": "What are you looking for?",
      "required": true
    }
  ],
  "layout": {
    "columns": 3,
    "gap": "16px",
    "mode": "grid"
  },
  "logo_url": "https://example.com/logo.png",
  "markdowns": [
    {
      "content": "# AI-Powered Product Search\n\nOur search uses **machine learning** to understand your queries and find the most relevant products.\n\n## Features\n\n- **Semantic Search**: Understands meaning, not just keywords\n- **Visual Search**: Upload images to find similar products\n- **Smart Filters**: Automatically suggests relevant filters",
      "title": "How it Works"
    },
    {
      "content": "## Tips for Better Results\n\n1. Use descriptive terms (e.g., \"wireless noise-canceling headphones\")\n2. Try different keywords if you don't find what you're looking for\n3. Use filters to narrow down results\n\n*Happy searching!*",
      "title": "Search Guide"
    }
  ],
  "template_type": "media-search",
  "theme": {
    "border_radius": "12px",
    "card_style": "elevated",
    "font_family": "Inter, sans-serif",
    "primary_color": "#007AFF"
  },
  "title": "Product Search"
}
​
rate_limit_config
RateLimitConfig · object
required

Rate limiting configuration

Examples:
{
  "description": "Standard tier (default) - 10/min, 100/hour, 1k/day",
  "enabled": true,
  "max_results_per_query": 50,
  "tier": "standard"
}
{
  "description": "Elevated tier - 30/min, 500/hour, 5k/day",
  "enable_ip_limits": true,
  "enabled": true,
  "max_requests_per_ip_hour": 100,
  "max_results_per_query": 100,
  "tier": "elevated"
}
{
  "description": "Enterprise tier - 100/min, 2k/hour, 20k/day",
  "enable_ip_limits": true,
  "enabled": true,
  "max_requests_per_ip_hour": 500,
  "max_results_per_query": 200,
  "tier": "enterprise"
}
{
  "description": "Custom limits overriding standard tier",
  "enabled": true,
  "max_results_per_query": 100,
  "requests_per_hour": 200,
  "requests_per_minute": 20,
  "tier": "standard"
}
​
password_protected
boolean
required

Whether password protection is enabled

​
is_active
boolean
required

Whether the published retriever is active

​
created_at
string<date-time>
required

Timestamp when published

​
updated_at
string<date-time>
required

Timestamp when last updated

​
description
string | null

Description of this public retriever

​
icon_base64
string | null

Base64 encoded icon/favicon for this retriever

​
public_api_key
string | null

DEPRECATED: Public API key (prk_). API keys are no longer required for public retriever access. For SDK access, use ret_sk_ keys.

​
retriever_metadata
RetrieverMetadata · object

Optional technical metadata about the retriever

​
tags
string[]

Tags for categorizing this retriever

​
category
string | null

Primary category for this retriever