Overview
An App is a fully hosted, versioned web application that you own and deploy through Mixpeek. Upload your code as a.zip bundle, configure a domain, and your app is live — no infrastructure required.
Apps replace the legacy Pages concept. While Pages were managed templates, Apps give you full control: write any frontend code, call Mixpeek APIs via the canvas SDK, and ship it under your own brand.
Bring your own code
Upload any React, vanilla JS, or static site. Mixpeek builds and serves it automatically.
Custom domains
Point any subdomain via CNAME. TLS is provisioned automatically.
Built-in auth
Clerk-powered sign-in (Google, GitHub, email) — auto-injected into your app with zero config.
Deploy history & rollback
Every deploy is versioned. Rollback to any previous build in one click.
Quickstart
Create an App in Studio
Go to Apps → Create App. Give it a name and a globally-unique slug — this becomes your default URL at
https://{slug}.mxp.co.Build your frontend
Write a React app (or any static site) that calls Mixpeek APIs via the canvas proxy. See the example below.
Deploy the bundle
In the App details page, drag & drop your
.zip onto the Deploy panel and click Deploy. Your build is queued immediately.Or via API:Canvas SDK
The canvas runtime injects credentials server-side — your API key never reaches the browser. Call any Mixpeek API through the/_api proxy:
What /_api supports
The proxy forwards all Mixpeek API methods with your org’s credentials injected:
| Category | Example paths |
|---|---|
| Retrievers | /_api/v1/retrievers/{id}/execute, /_api/v1/retrievers/list |
| Collections | /_api/v1/collections/list, /_api/v1/collections/{id} |
| Documents | /_api/v1/documents/{id}, /_api/v1/documents/list |
| Namespaces | /_api/v1/namespaces/list |
| Batches | /_api/v1/batches/list, /_api/v1/batches/{id} |
| Tasks | /_api/v1/tasks/{id}, /_api/v1/tasks/list |
| Marketplace | /_api/v1/marketplace/catalog/{name}/execute |
| Taxonomies | /_api/v1/taxonomies/list, /_api/v1/taxonomies/{id}/classify |
Use
/_api/v1/... (relative path) instead of https://api.mixpeek.com/v1/... — the canvas proxy injects Authorization and X-Namespace headers automatically, avoiding CORS and keeping API keys out of your bundle.Using the Mixpeek JS SDK
You can also use themixpeek npm package pointed at /_api:
Billing
All API calls through/_api are billed to the organization that owns the canvas app. End-users don’t need their own Mixpeek API keys or accounts — usage is attributed to your org automatically.
Creating an App
Via Studio
Go to Apps → Create App in the Mixpeek Studio. The two-step wizard collects:- Name + Slug — the name is display-only; the slug becomes your URL (
{slug}.apps.mixpeek.com) and must be globally unique - Access Control — choose how end-users authenticate (public, password, API key, JWT, or SSO)
Via API
Deploy lifecycle
Every deploy creates a new versioned build. The lifecycle is:| Stage | Description |
|---|---|
pending | Bundle uploaded, build queued |
building | Mixpeek is building and packaging your bundle |
success | Build complete — app is live |
failed | Build failed — check logs, previous version stays live |
Draft vs Published
Edits to app config (tabs, auth, meta) are saved as drafts and are not visible to end-users until you click Publish. Code deploys go live immediately after a successful build.- Publish — makes the current config draft live (
POST /v1/apps/{id}/publish) - Rollback — restores the previous published config (
POST /v1/apps/{id}/rollback)
Authentication modes
| Mode | Description |
|---|---|
public | Anyone can access — no login required |
password | Shared password gate |
api_key | Requires X-App-Key header |
jwt | Customer-managed tokens |
sso_oidc | Okta, Auth0, Azure AD |
sso_saml | Enterprise SAML 2.0 IdP |
Auth enforcement activates when the canvas runtime is deployed. Config is stored now and takes effect automatically.
Custom domains
Add a custom domain in the Domains panel on the App details page:- Enter your subdomain (e.g.,
search.yourdomain.com) - Add a
CNAMErecord pointing to{slug}.pages.dev - Mixpeek provisions a TLS certificate automatically via Cloudflare
active.
Example apps
E-commerce product search
React app with multimodal search — text queries, image upload, and faceted filters backed by a Mixpeek retriever.
Internal knowledge base
Password-protected semantic search over company documents, PDFs, and meeting transcripts.
Media library
Video + image search portal with scene-level results, thumbnails, and timestamp previews.
Content moderation dashboard
Real-time moderation queue pulling from alert webhooks and showing flagged content with similarity scores.

