Skip to main content
POST
/
v2
/
studio
/
deployment
/
Create a miniapp generator deployment
curl --request POST \
  --url https://api.neynar.com/v2/studio/deployment/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "fid": 1,
  "env": {},
  "display_name": "<string>"
}'
{
  "status": "<string>",
  "display_name": "<string>",
  "url": "<string>",
  "github_url": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "namespace": "<string>",
  "name": "<string>",
  "isReady": true
}
The Miniapp Studio API is an allowlisted API and not publicly available. Contact the Neynar team for more information.

Authorizations

x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Body

application/json
fid
integer | null
required

Farcaster ID of the user

Required range: x >= 0
env
object

Environment variables for the deployment

display_name
string

Display name for the deployment

Response

Success

created_at
string<date-time>
required

Creation timestamp

namespace
string
required

Kubernetes namespace

name
string
required

Kubernetes deployment name

isReady
boolean
required

Deployment is ready to serve app and accept prompts

status
string

Kubernetes deployment status

display_name
string

Display name for the project

url
string<uri>

Public URL for the deployment

github_url
string<uri>

GitHub repository URL

I