Get Public Retriever Config

curl --request GET \
  --url https://api.mixpeek.com/v1/public/retrievers/{public_name}/config \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.mixpeek.com/v1/public/retrievers/{public_name}/config"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.mixpeek.com/v1/public/retrievers/{public_name}/config', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mixpeek.com/v1/public/retrievers/{public_name}/config",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mixpeek.com/v1/public/retrievers/{public_name}/config"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.mixpeek.com/v1/public/retrievers/{public_name}/config")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/public/retrievers/{public_name}/config")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "public_name": "<string>",
  "display_config": {
    "title": "<string>",
    "inputs": [
      {
        "field_name": "<string>",
        "field_schema": {
          "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": {}
  },
  "password_protected": true,
  "public_api_key": "<string>",
  "retriever_metadata": {
    "stages": [
      {}
    ],
    "collections": [
      {}
    ],
    "capabilities": {}
  }
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

Public Retriever API

Get Public Retriever Config

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):

curl -X GET "https://api.mixpeek.com/v1/public/retrievers/video-search/config"

Example (recommended):

curl -X GET "https://api.mixpeek.com/v1/marketplace/catalog/video-search/config"

GET

public

retrievers

{public_name}

config

Get Public Retriever Config

curl --request GET \
  --url https://api.mixpeek.com/v1/public/retrievers/{public_name}/config \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.mixpeek.com/v1/public/retrievers/{public_name}/config"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.mixpeek.com/v1/public/retrievers/{public_name}/config', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mixpeek.com/v1/public/retrievers/{public_name}/config",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mixpeek.com/v1/public/retrievers/{public_name}/config"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.mixpeek.com/v1/public/retrievers/{public_name}/config")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/public/retrievers/{public_name}/config")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "public_name": "<string>",
  "display_config": {
    "title": "<string>",
    "inputs": [
      {
        "field_name": "<string>",
        "field_schema": {
          "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": {}
  },
  "password_protected": true,
  "public_api_key": "<string>",
  "retriever_metadata": {
    "stages": [
      {}
    ],
    "collections": [
      {}
    ],
    "capabilities": {}
  }
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

public_name

string

required

Public name of the published retriever

Response

Successful Response

Response for fetching public retriever configuration (for UI rendering).

This is what the public frontend (mxp.co/r/{name}) fetches to render the search interface. It includes everything needed for UI rendering.

Note: API keys are no longer required. The execute endpoint can be called without authentication - rate limiting and optional password protection provide security.

public_name

string

required

Public name of the retriever

display_config

DisplayConfig · object

required

Display configuration for rendering the UI. Includes inputs, theme, layout, and exposed fields.

Show child attributes

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"
}

password_protected

boolean

required

Whether this retriever requires password authentication

public_api_key

string | null

DEPRECATED: API keys are no longer required for public access. The execute endpoint can be called without authentication.

retriever_metadata

RetrieverMetadata · object | null

OPTIONAL. Technical metadata about how the retriever works. Only present if include_metadata=True was set during publishing.

Show child attributes

List Public Retrievers Get Public Retriever Template

Organization

Namespaces

Buckets

Feature Extractors

Batch Queue

Collections

Documents

Retrievers

Taxonomies

Clusters

Triggers

Alerts

Webhooks

Apps

Agent Sessions

Annotations

Templates

Manifest

Discovery

Analytics

Notifications

Tasks

Inference

Resource Search

Pricing

Get Public Retriever Config

Authorizations

Path Parameters

Response