Skip to main content
POST
/
v2
/
farcaster
/
frame
/
Create mini app
curl --request POST \
  --url https://api.neynar.com/v2/farcaster/frame/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "pages": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version": "vNext",
      "title": "Welcome to Neynar",
      "image": {
        "url": "https://i.imgur.com/qo2AzBf.jpeg",
        "aspect_ratio": "1.91:1"
      },
      "buttons": [
        {
          "title": "<string>",
          "index": 123,
          "action_type": "post",
          "next_page": {
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        }
      ],
      "input": {
        "text": {
          "enabled": false,
          "placeholder": "<string>"
        }
      }
    }
  ]
}'
{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "link": "<string>",
  "pages": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version": "vNext",
      "title": "Welcome to Neynar",
      "image": {
        "url": "https://i.imgur.com/qo2AzBf.jpeg",
        "aspect_ratio": "1.91:1"
      },
      "buttons": [
        {
          "title": "<string>",
          "index": 123,
          "action_type": "post",
          "next_page": {
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        }
      ],
      "input": {
        "text": {
          "enabled": false,
          "placeholder": "<string>"
        }
      }
    }
  ],
  "valid": true
}

Authorizations

​
x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Body

application/json
​
name
string
required

The name of the mini app.

​
pages
NeynarFramePage · object[]
required

Response

Success

​
uuid
string<uuid>
required

Unique identifier for the mini app.

​
name
string
required

Name of the mini app.

​
link
string<uri>
required

Generated link for the mini app's first page.

​
pages
NeynarFramePage · object[]
required
​
valid
boolean

Indicates if the mini app is valid.

⌘I