Skip to main content
GET
/
v2
/
studio
/
deployment
/
by-name-and-fid
Get deployment info
curl --request GET \
  --url https://api.neynar.com/v2/studio/deployment/by-name-and-fid \
  --header 'x-api-key: <api-key>'
{
  "created_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "generated_app_exists": true,
  "generated_app_serving": true,
  "id": "<string>",
  "is_ready": true,
  "name": "<string>",
  "namespace": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "display_name": "<string>",
  "github_url": "<string>",
  "has_database": true,
  "production_app_status": {
    "created_at": 123,
    "deployment_state": "<string>",
    "deployment_url": "<string>",
    "project_id": "<string>",
    "target": "<string>"
  },
  "url": "<string>"
}
The Miniapp Studio API is an allowlisted API and not publicly available. Contact the Neynar team for more information.

ā€‹
Node.js SDK

šŸ”— SDK Method: getDeployment Use this API endpoint with the Neynar Node.js SDK for typed responses and better developer experience.

Authorizations

ā€‹
x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Query Parameters

ā€‹
deployment_id
string<uuid>

Deployment ID (UUID). Required if name not provided.

ā€‹
fid
integer<int32>

Farcaster ID of the user; if not provided, namespace must be provided

Required range: x >= 0
Example:

3

ā€‹
name
string

Kubernetes deployment name. Required if deployment_id not provided.

ā€‹
namespace
string

Optional Kubernetes namespace. If not provided, will query for the active namespace for the given FID.

Response

Success

ā€‹
created_at
string<date-time>
required

Creation timestamp

ā€‹
deleted_at
string<date-time> | null
required

Deletion timestamp

ā€‹
generated_app_exists
boolean
required

Whether a generated app exists in the deployment

ā€‹
generated_app_serving
boolean
required

Whether the generated app is currently serving

ā€‹
id
string
required

Deployment ID

ā€‹
is_ready
boolean
required

Deployment is ready to serve app and accept prompts

ā€‹
name
string
required

Kubernetes deployment name

ā€‹
namespace
string
required

Kubernetes namespace

ā€‹
updated_at
string<date-time> | null
required

Last update timestamp

ā€‹
dev_server_state
enum<string>

Dev server process state: stopped, starting, running, crashed, or hung

Available options:
stopped,
starting,
running,
crashed,
hung
ā€‹
display_name
string

Display name for the project

ā€‹
github_url
string

GitHub repository SSH URL

ā€‹
has_database
boolean

Whether the deployment has a Neon database configured

ā€‹
production_app_status
object

Production app deployment status from Vercel

ā€‹
url
string<uri>

Public URL for the deployment