POST
/
farcaster
/
frame
/
action
curl --request POST \
  --url https://api.neynar.com/v2/farcaster/frame/action \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "signer_uuid": "19d0c5fd-9b33-4a48-a0e2-bc7b0555baec",
  "cast_hash": "0xfe90f9de682273e05b201629ad2338bdcd89b6be",
  "action": {
    "version": "<string>",
    "title": "<string>",
    "image": "<string>",
    "button": {
      "title": "<string>",
      "index": 123,
      "action_type": "post",
      "target": "<string>",
      "post_url": "<string>"
    },
    "input": {
      "text": "Draw a purple ringed planet"
    },
    "state": {
      "serialized": "%7B%22counter%22%3A1%7D"
    },
    "transaction": {
      "hash": "0xa80de157a3ab4648db1ecfab7e6355b342215bc549f6e37be9e6da527cc024f7"
    },
    "address": "<string>",
    "frames_url": "<string>",
    "post_url": "<string>"
  }
}'
{
  "version": "<string>",
  "image": "<string>",
  "frames_url": "<string>",
  "buttons": [
    {
      "title": "<string>",
      "index": 123,
      "action_type": "post",
      "target": "<string>",
      "post_url": "<string>"
    }
  ],
  "post_url": "<string>",
  "title": "<string>",
  "image_aspect_ratio": "<string>",
  "input": {
    "text": "<string>"
  },
  "state": {
    "serialized": "<string>"
  }
}

To learn more about using this route on your own backend to handle frame interactions, click here to read our guide

The post frame action API can be used by clients to interact with a frame. You need to have an approved signer_uuid to post a frame action.

The POST request to the post_url has a timeout of 5 seconds.

Authorizations

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

API key to authorize requests

Body

application/json

Response

200
application/json

Successful operation.

Mini app v1 object