Create an App
Create a new App.
Apps are full-stack multimodal search applications where Mixpeek is the entire backend and the frontend is customizable JSX, deployed to the customer’s own subdomain.
Rendering modes (in priority order):
custom_html— raw HTML/CSS/JS in a sandboxed iframe (full control)sections[]— slot-based composition with typed blocks (template: "generic")- Named presets —
template: "brand-compliance"etc. (legacy compat)
Slugs are globally unique across all organizations.
Set auth_config.mode to control end-user authentication (public,
password, api_key, jwt, sso_oidc, sso_saml). Auth enforcement
is activated in Phase 5; the config is stored but not yet enforced.
Headers
REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.
"Bearer YOUR_API_KEY"
"Bearer YOUR_STRIPE_API_KEY"
REQUIRED: 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'
"ns_abc123def456"
"production"
"my-namespace"
Body
Request to create a new App.
URL-safe slug (globally unique, lowercase + hyphens)
3 - 60^[a-z0-9][a-z0-9-]*[a-z0-9]$"my-product-search"
"brand-dashboard"
App metadata (title, logo, favicon)
Hero section configuration for a page.
Theme configuration for public retriever UI.
Defines colors, fonts, and visual styling for the public search interface.
SEO configuration for public retriever discoverability.
Auto-generated during publishing with sensible defaults inferred from the retriever's display_config. All fields can be overridden manually.
This configuration controls how the public retriever appears in:
- Search engine results (Google, Bing, etc.)
- Social media shares (Twitter, Facebook, LinkedIn)
- Link previews in messaging apps
{
"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"
}Configuration for the featured gallery section.
End-user authentication configuration for an App.
Phase 1: schema stored on the document; enforcement not yet wired up. Phase 5: middleware in canvas/ will enforce these settings.
JSX build configuration for an App.
Phase 1: schema only. Phase 3: used by the build pipeline Celery task.
Response
The created App configuration
Response model for an App.
Page-level metadata (REQUIRED when creating a page).
This object is separate from the optional seo field.
meta controls the visible page chrome (browser tab title, logo, favicon),
while seo controls search-engine tags (og:title, og:description, etc.).
Hero section configuration for a page.
Theme configuration for public retriever UI.
Defines colors, fonts, and visual styling for the public search interface.
SEO configuration for public retriever discoverability.
Auto-generated during publishing with sensible defaults inferred from the retriever's display_config. All fields can be overridden manually.
This configuration controls how the public retriever appears in:
- Search engine results (Google, Bing, etc.)
- Social media shares (Twitter, Facebook, LinkedIn)
- Link previews in messaging apps
{
"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"
}Configuration for the featured gallery section.
End-user authentication configuration for an App.
Phase 1: schema stored on the document; enforcement not yet wired up. Phase 5: middleware in canvas/ will enforce these settings.
JSX build configuration for an App.
Phase 1: schema only. Phase 3: used by the build pipeline Celery task.