Neynar Hosted Frames
Create mini app
Farcaster API V2
- User
- Signer
- Cast
- Feed
- Reaction
- Notifications
- Channel
- Follows
- Storage
- Mini Apps
- Notifications
- Developer Hosted Frames
- Neynar Hosted Frames
- GETMini apps catalog
- GETRelevant mini apps
- GETMeta tags from URL
- POSTSignature packet
- Agents
- Fname
- Webhook
- Action
- Mute
- Block
- Ban
- Onchain
- Login
- Metrics
Onchain
Farcaster Hub API
- Info
- Casts
- Reactions
- Links
- UserData
- Fids
- Storage
- Usernames
- Verifications
- OnChainEvents
- Message
- HubEvents
Neynar SDK
- Getting Started with Neynar NodeJS SDK
- SDK v1 to v2 migration guide
Neynar Hosted Frames
Create mini app
Create a new mini app with a list of pages.
POST
/
farcaster
/
frame
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
}
Related doc: Dynamic frame creation
Authorizations
API key to authorize requests
Body
application/json
Response
200
application/json
Mini app created successfully
The response is of type object
.
Was this page helpful?
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
}