Sign in

v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB
Apps

Create an App

Create a new App.

Apps are full-stack web applications deployed as zip bundles to {slug}.mxp.co. After creation, deploy your built frontend via the deploy pipeline:

  1. POST /v1/apps/{app_id}/deploy/upload-url — get a presigned S3 PUT URL
  2. Upload your built dist/ zip to that URL
  3. POST /v1/apps/{app_id}/deploy — trigger the build

Only slug and meta are required. Set auth_config.mode to control end-user authentication (public, clerk, password, api_key, jwt, sso_oidc, sso_saml).

Slugs are globally unique across all organizations.

Deprecated fields: template, sections, custom_html, hero, theme, seo, stats, featured_gallery, tabs, password_secret_name are accepted for backward compatibility but should not be used for new apps.

Tier limits: Free = 1 app, Pro = 10, Enterprise = unlimited (TierLimits._max_apps). Exceeding your tier's limit returns a 400 with the limit + current count in error.details.

post/v1/apps

Request body

slugstring required

URL-safe slug (globally unique, lowercase + hyphens). Becomes your URL: {slug}.mxp.co

is_activeboolean
templatestring
custom_htmlstring nullable
password_secret_namestring nullable

Example request

{
  "meta": {
    "title": "Product Search"
  },
  "slug": "my-product-search"
}

Response

The created App configuration

app_idstring required
slugstring required
urlstring required

Canonical published URL (https://{slug}.mxp.co)

is_activeboolean required
warningsstring[]

Non-fatal advisories about the request that was just applied. Currently used to spell out the effect of a takedown write, e.g. 'is_active: false' makes the canvas runtime refuse the app's URL with a 404 within its serving-cache window, and the note says how to verify that. Additive and safe to ignore.

versioninteger required
has_unpublished_changesboolean
repo_urlstring nullable
repo_branchstring nullable
github_installation_idinteger nullable
environmentsobject required
created_atstring date-time nullable required
updated_atstring date-time nullable required
templatestring required
custom_htmlstring nullable required
password_protectedboolean required

Example response

{
  "meta": {
    "title": "My Product Search",
    "description": "Search across 10k+ product images",
    "logo_url": "https://cdn.example.com/logo.png",
    "favicon_url": "https://cdn.example.com/favicon.ico"
  },
  "theme": {
    "primary_color": "#007AFF",
    "secondary_color": "#FF6B6B",
    "font_family": "Inter, sans-serif",
    "heading_font_family": "Georgia, serif",
    "surface_color": "#F9FAFB",
    "muted_color": "#6B7280",
    "border_color": "#E5E7EB",
    "border_radius": "8px",
    "card_style": "elevated",
    "card_hover_effect": "lift"
  },
  "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"
  },
  "featured_gallery": {
    "layout": {
      "mode": "grid",
      "gap": "8px"
    }
  },
  "tabs": [
    {
      "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"
      }
    }
  ]
}