Get Published Retriever

curl --request GET \
  --url https://api.mixpeek.com/v1/retrievers/{retriever_id}/publish \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Namespace: <api-key>'

import requests

url = "https://api.mixpeek.com/v1/retrievers/{retriever_id}/publish"

headers = {
    "Authorization": "Bearer <token>",
    "X-Namespace": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'X-Namespace': '<api-key>'}
};

fetch('https://api.mixpeek.com/v1/retrievers/{retriever_id}/publish', 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/retrievers/{retriever_id}/publish",
  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>",
    "X-Namespace: <api-key>"
  ],
]);

$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/retrievers/{retriever_id}/publish"

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Namespace", "<api-key>")

	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/retrievers/{retriever_id}/publish")
  .header("Authorization", "Bearer <token>")
  .header("X-Namespace", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/retrievers/{retriever_id}/publish")

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

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

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

{
  "retriever_id": "<string>",
  "public_id": "<string>",
  "public_name": "<string>",
  "display_config": {
    "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": {
    "description": "Standard tier (default) - 10/min, 100/hour, 1k/day",
    "enabled": true,
    "max_results_per_query": 50,
    "tier": "standard"
  },
  "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": [
      {
        "stage_name": "feature_filter",
        "stage_type": "filter"
      },
      {
        "stage_name": "llm_filter",
        "stage_type": "filter"
      }
    ],
    "collections": [
      {
        "collection_id": "col_abc123",
        "collection_name": "Products",
        "feature_extractor": {
          "name": "multimodal_extractor",
          "version": "v1"
        }
      }
    ],
    "capabilities": {
      "multi_stage_pipeline": true,
      "stage_count": 2,
      "supports_image_search": true,
      "supports_text_search": true
    }
  },
  "tags": [
    "<string>"
  ],
  "category": "<string>"
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

Publishing

Get Published Retriever

Get published retriever details.

Returns configuration including public URL, display settings, and rate limits. The public API key is not returned (it was shown only once during publishing).

A retriever that simply hasn’t been published yet is a normal state (the Studio Publish tab opens this on every visit), not an error — so this returns 200 with a null body rather than 404, which previously logged a console error for every unpublished retriever.

GET

retrievers

{retriever_id}

publish

Get Published Retriever

curl --request GET \
  --url https://api.mixpeek.com/v1/retrievers/{retriever_id}/publish \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Namespace: <api-key>'

import requests

url = "https://api.mixpeek.com/v1/retrievers/{retriever_id}/publish"

headers = {
    "Authorization": "Bearer <token>",
    "X-Namespace": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'X-Namespace': '<api-key>'}
};

fetch('https://api.mixpeek.com/v1/retrievers/{retriever_id}/publish', 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/retrievers/{retriever_id}/publish",
  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>",
    "X-Namespace: <api-key>"
  ],
]);

$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/retrievers/{retriever_id}/publish"

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Namespace", "<api-key>")

	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/retrievers/{retriever_id}/publish")
  .header("Authorization", "Bearer <token>")
  .header("X-Namespace", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/retrievers/{retriever_id}/publish")

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

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

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

{
  "retriever_id": "<string>",
  "public_id": "<string>",
  "public_name": "<string>",
  "display_config": {
    "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": {
    "description": "Standard tier (default) - 10/min, 100/hour, 1k/day",
    "enabled": true,
    "max_results_per_query": 50,
    "tier": "standard"
  },
  "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": [
      {
        "stage_name": "feature_filter",
        "stage_type": "filter"
      },
      {
        "stage_name": "llm_filter",
        "stage_type": "filter"
      }
    ],
    "collections": [
      {
        "collection_id": "col_abc123",
        "collection_name": "Products",
        "feature_extractor": {
          "name": "multimodal_extractor",
          "version": "v1"
        }
      }
    ],
    "capabilities": {
      "multi_stage_pipeline": true,
      "stage_count": 2,
      "supports_image_search": true,
      "supports_text_search": true
    }
  },
  "tags": [
    "<string>"
  ],
  "category": "<string>"
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

Authorizations

Authorization

string

header

required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing, malformed, unknown, revoked, inactive or expired key returns 401; a key without the permission, scope or plan an operation needs returns 403.

X-Namespace

string

header

required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Path Parameters

retriever_id

string

required

ID of the retriever

Response

PublishedRetrieverResponse · object | null

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

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

rate_limit_config

RateLimitConfig · object

required

Rate limiting configuration

Show child attributes

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 | null

Optional technical metadata about the retriever

Show child attributes

Namespaces

Buckets

Collections

Feature Extractors

Documents

Retrievers

Enrich & Improve

Automate

Administer

Advanced

Get Published Retriever

Authorizations

Path Parameters

Response