Skip to main content
Mini app feed

Mini App embed in social feed

Implementation

Add this meta tag to the <head> section of any page you want to make shareable:
<!DOCTYPE html>
<html lang="en">
  <head>
    <title>My Mini App</title>
    <meta
      name="fc:miniapp"
      content='{
        "version": "next",
        "imageUrl": "https://example.com/preview.png",
        "button": {
          "title": "Open App",
          "action": {
            "type": "launch_frame",
            "url": "https://example.com"
          }
        }
      }'
    />
  </head>
  <body>
    <!-- Your app content -->
  </body>
</html>
The homeUrl used in the manifest must have embed metadata defined, in order for the mini app to render correctly in the Base app.

Schema

version
string
required
Version of the embed. Must be "1" or "next".
imageUrl
string
required
Image URL for the embed. Must be 3:2 aspect ratio, maximum 10MB, maximum 1024 characters.
button
object
required
Button configuration object.

Button Configuration

Defines the launch button that appears on the embed.

button.title
string
required
Button text. Maximum 32 characters.
button.action
object
required
Action configuration object. Maximum 1024 characters.

Action Configuration

Specifies what happens when the embed button is clicked.

button.action.type
string
required
Action type. Must be "launch_frame".
button.action.url
string
App URL to open. Defaults to the full URL of the page including query parameters. Maximum 1024 characters.
button.action.name
string
Application name. Maximum 32 characters. Defaults to manifest name.
button.action.splashImageUrl
string
Splash screen image URL. Must be 200x200 pixels. Maximum 32 characters. Defaults to manifest splash image.
button.action.splashBackgroundColor
string
Splash screen background color. Must be hex color code. Defaults to manifest splash background color.
I