Sign in
mini-apps

Get the public mini-app marketing projection

Returns the public-safe mini-app metadata used to build marketing pages. The response includes only active marketing entries that have website metadata and can be published unchanged as the marketing registry.

get/mini-apps/marketing-projection

Response

Mini-app marketing projection retrieved successfully

slugstring required

Unique, stable, URL-safe mini-app identifier.

labelstring required

Human-readable mini-app name.

descriptionstring nullable

Short description of what the mini-app does.

embed'iframe' | 'native' required

How the mini-app runs. Iframe apps use hosted deployments; native apps are bundled into the Ideogram frontend.

iconstring nullable

Public URL for the mini-app icon.

coverstring nullable

Public URL for the mini-app cover image.

cardstring nullable

Public URL for the mini-app card image.

websiteobject required

Structured metadata used to build the mini-app marketing page.

archived_atstring date-time nullable

Archive timestamp; active projection entries omit this field.

is_marketingboolean required

Whether the entry is selected for public marketing pages.

deployment_urlstring uri nullable

Public URL where a hosted mini-app is served. Native apps omit this field.

deployment_commitstring nullable

Source commit hash of the deployed build.

deployment_timestring date-time nullable

When the deployment that produced this build completed.

Example response

[
  {
    "is_marketing": true,
    "website": {
      "key": ""
    },
    "deployment_time": "2000-01-23T04:56:07+00:00",
    "archived_at": "2000-01-23T04:56:07+00:00",
    "deployment_url": "https://openapi-generator.tech",
    "deployment_commit": "deployment_commit",
    "icon": "icon",
    "description": "description",
    "label": "label",
    "cover": "cover",
    "embed": "iframe",
    "slug": "slug",
    "card": "card"
  }
]

Changes

Changed in 3 of the 34 revisions of this API.12