Implementation
- Create the manifest file in your project at
/public/.well-known/farcaster.json
. It needs to be accessible athttps://your-domain.com/.well-known/farcaster.json
- Update the required and optional fields in the
miniapp
object - Ensure all changes are live so that the Manifest file is available at your app’s url
- Navigate to the Base Build Account association tool
- Paste your domain in the App URL field (ex: sample-url.vercel.app) and click “Submit”
- Click on the “Verify” button that appears and sign the manifest with your wallet to generate the
accountAssociation
fields - Copy the generated
accountAssociation
fields (header, payload, and signature) and paste them into your manifest file, replacing the empty values in theaccountAssociation
object
Changes to the manifest take effect when you redeploy your Mini App and repost it. The platform re-indexes the updated configuration and applies changes to search, discovery, and embed rendering.
Schema
accountAssociation
Proves domain ownership for your Mini App.baseBuilder
This verifies ownership and connects your Base Build account.This address should be the address of the wallet used when importing your mini app to Base Build.This verifies ownership and connects your Base Build account.
Identity & Launch
Defines your Mini App’s core identity and the URL users land on when they open it.Loading Experience
Controls the splash screen visuals and colors shown while your Mini App loads.Discovery & Search
Determines how your Mini App is indexed, categorized, and surfaced across Base App discovery features.Controls where your app appears in category browsing. One of:
games
, social
, finance
, utility
, productivity
, health-fitness
, news-media
, music
, shopping
, education
, developer-tools
, entertainment
, art-creativity
.Search/filter tags. Up to 5; ≤ 20 chars each; lowercase; no spaces/emojis/special chars.
Exclude from search results.
true
= exclude, default = include.Display Information
Provides the descriptive text, screenshots, and promotional images shown on your Mini App’s profile.Short description under name. Max 30 chars; avoid emojis/special chars.
Promo text for app page. Max 170 chars; avoid emojis/special chars.
Marketing tagline. Max 30 chars.
Large promo image. 1200×630px (1.91:1), PNG/JPG.
Visual previews. Max 3; portrait 1284×2778px recommended.
Notifications
Notification endpoint.POST events endpoint. HTTPS URL, max 1024 chars. Required if using notifications.