Skip to main content
objectMiniAppGeneralInfoResponse

Fields

ns
String

Unique miniapp namespace, used to reference this app in other calls (e.g. appNs).

title
String

Marketplace listing title.

label
String

Short label shown in compact UI (menus, badges).

name
String

Internal/display name of the miniapp.

description
String

Full marketplace description.

shortDescription
String

One-line summary for listing cards.

userGuide
String

Setup and usage guide content for this miniapp.

features
String

Feature highlights for the marketplace listing.

categories
[String]

Marketplace category tags this miniapp is listed under.

category
String

Primary marketplace category.

screenShots
JSON

Listing screenshot(s) — either a single URL string or an array of URLs.

icon
String

Icon image URL.

Logo image URL.

docsUrl
String

Link to external documentation for this miniapp.

youtubeId
String

YouTube video id for a demo/walkthrough, if available.

price
JSON

Pricing details for this miniapp (plan tiers, currency, etc.).

version
String

Currently published version string.

type
String

Miniapp type/kind, as defined by its registry entry.

status
String

Publication status of this miniapp in the marketplace.

installStatus
String

Install status for the current workspace, e.g. installed, not_installed.

installationCount
Int

Number of workspaces that have installed this miniapp.

auth
AuthResponse

Authentication requirements and current state. See AuthResponse.

author
JSON

Author/publisher information for this miniapp.

آخر تعديل في ١١ أغسطس ٢٠٢٦