Get an App

Get an App by its app_id.

GET /v1/apps/{app_id}

Get an App

cURL

curl --request GET \
  --url https://api.mixpeek.com/v1/apps/{app_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "app_id": "<string>",
  "slug": "<string>",
  "url": "<string>",
  "meta": {
    "title": "<string>",
    "description": "Search across 10k+ product images",
    "logo_url": "https://cdn.example.com/logo.png",
    "favicon_url": "https://cdn.example.com/favicon.ico",
    "indexable": false
  },
  "is_active": true,
  "version": 123,
  "custom_domains": [
    {
      "domain": "<string>",
      "status": "pending",
      "verification_token": "<string>",
      "cname_target": "<string>",
      "tls_cert_id": "<string>",
      "tls_expires_at": "2023-11-07T05:31:56Z",
      "verified_at": "2023-11-07T05:31:56Z",
      "is_primary": false
    }
  ],
  "auth_config": {
    "mode": "public",
    "clerk_org_id": "<string>",
    "clerk_allowed_providers": [
      "<string>"
    ],
    "password_hash": "<string>",
    "saml_idp_metadata_url": "<string>",
    "saml_sp_entity_id": "<string>",
    "saml_acs_url": "<string>",
    "oidc_issuer": "<string>",
    "oidc_client_id": "<string>",
    "oidc_client_secret_name": "<string>",
    "oidc_scopes": [
      "<string>"
    ],
    "jwt_jwks_url": "<string>",
    "jwt_audience": "<string>",
    "jwt_issuer": "<string>",
    "api_keys": [
      {}
    ]
  },
  "build_config": {
    "entry": "src/layout.jsx",
    "framework": "react",
    "tailwind": true,
    "env_vars": {},
    "secrets": {},
    "asset_prefix": "<string>"
  },
  "environments": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "template": "<string>",
  "sections": [
    {
      "type": "<string>",
      "section_id": "<string>",
      "props": {},
      "order": 123
    }
  ],
  "custom_html": "<string>",
  "hero": {
    "headline": "<string>",
    "subheadline": "<string>",
    "background_type": "solid",
    "background_url": "<string>",
    "background_color": "<string>",
    "text_color": "#FFFFFF",
    "logo_url": "<string>",
    "height": "420px",
    "cta_label": "<string>",
    "cta_url": "<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"
  },
  "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"
  },
  "stats": [
    {
      "label": "<string>",
      "value": "<string>"
    }
  ],
  "featured_gallery": {
    "enabled": true,
    "title": "Featured",
    "retriever_id": "<string>",
    "public_name": "<string>",
    "default_inputs": {},
    "layout": {
      "mode": "grid",
      "columns": 3,
      "gap": "16px",
      "full_width": false
    },
    "field_config": {}
  },
  "tabs": [
    {
      "tab_id": "<string>",
      "label": "<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": {}
      },
      "retriever_id": "<string>",
      "public_name": "<string>",
      "description": "<string>"
    }
  ],
  "password_protected": true,
  "warnings": [
    "<string>"
  ],
  "has_unpublished_changes": false,
  "monitoring_config": {
    "enabled": true,
    "error_boundary_enabled": true,
    "sentry_enabled": true,
    "posthog_enabled": true,
    "custom_error_message": "<string>",
    "auto_fix_enabled": true
  },
  "repo_url": "<string>",
  "repo_branch": "<string>",
  "github_installation_id": 123,
  "versions": [
    {
      "version": 123,
      "s3_version_id": "<string>",
      "asset_prefix": "<string>",
      "asset_manifest": {},
      "asset_manifest_url": "<string>",
      "deployed_by": "<string>",
      "deployed_at": "2023-11-07T05:31:56Z",
      "environment": "production",
      "build_duration_ms": 123,
      "message": "<string>",
      "source_files": {},
      "git_commit_sha": "<string>",
      "git_commit_message": "<string>",
      "git_author": "<string>"
    }
  ]
}

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 header returns 403; an invalid or revoked key returns 401.

Path Parameters

app_id · string · required

App ID (e.g. app_abc123def456)

Response

200

application/json

Full App configuration

Response model for an App.

Deploy-based apps use versions, environments, build_config, and auth_config. Legacy page-builder fields (template, sections, custom_html, hero, theme, seo, stats, featured_gallery, tabs, password_protected) are included for backward compatibility but deprecated.

app_id · string · required

slug · string · required

url · string · required

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

meta · PageMeta · object · required

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

Show child attributes

is_active · boolean · required

version · integer · required

custom_domains · CustomDomainConfig · object[] · required

Show child attributes

auth_config · AuthConfig · object | null · required

End-user authentication configuration for an App.

Supported modes:

• public: No authentication required (default)
• clerk: Managed auth via Clerk Organizations — handles Google, GitHub, email/password signup/login. Each canvas app maps to a Clerk Organization. Users are synced to canvas_users via Clerk webhooks.
• password: Simple password gate — visitors must enter a password to access the app. The password is hashed (bcrypt) before storage.
• api_key, jwt, sso_oidc, sso_saml: Advanced modes retained for future use.

Show child attributes

build_config · BuildConfig · object | null · required

JSX build configuration for an App.

Phase 1: schema only. Phase 3: used by the build pipeline Celery task.

Show child attributes

environments · Environments · object · required

created_at · string<date-time> | null · required

updated_at · string<date-time> | null · required

template · string · required · deprecated

sections · SectionConfig · object[] · required · deprecated

Show child attributes

custom_html · string | null · required · deprecated

hero · HeroConfig · object | null · required · deprecated

Hero section configuration for a page.

Show child attributes

theme · ThemeConfig · object · required · deprecated

Theme configuration for public retriever UI.

Defines colors, fonts, and visual styling for the public search interface.

Show child attributes

seo · SEOConfig · object | null · required · deprecated

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

Show child attributes

Example:

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

stats · StatItem · object[] · required · deprecated

Show child attributes

featured_gallery · FeaturedGalleryConfig · object | null · required · deprecated

Configuration for the featured gallery section.

Show child attributes

tabs · PageTab · object[] · required · deprecated

Show child attributes

password_protected · boolean · required · deprecated

warnings · string[]

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.

has_unpublished_changes · boolean · default: false

monitoring_config · MonitoringConfig · object | null

Opt-in monitoring configuration for a Canvas app.

All monitoring is off by default except error_boundary_enabled, which is a client-side UX safety net (shows fallback UI instead of blank page) and sends no data externally.

When sentry_enabled or posthog_enabled are turned on, monitoring data is sent to Mixpeek-internal Sentry/PostHog — never to the customer's own observability stack. PII is stripped via beforeSend / mask_all_text, and session replay is always off.

Show child attributes

repo_url · string | null

repo_branch · string | null

github_installation_id · integer | null

versions · VersionRecord · object[]

Deploy version history with timestamps and environment info

Show child attributes