v1

latestOpenAPI 3.0.42026-07-26159287356.1 KB

studio

Create a miniapp generator deployment

Creates and deploys an instance of the miniapp generator for a user. Requires authentication via API key in the request header. Note: Studio CU is tracked based on LLM token usage, not per API call.

post/v2/studio/deployment/

Request body

display_namestring

Display name for the deployment

envobject

Environment variables for the deployment

fidinteger required

Farcaster ID of the user

Example request

{
  "fid": 3
}

Response

Success

created_atstring date-time required

Creation timestamp

deleted_atstring date-time nullable required

Deletion timestamp

dev_server_state'stopped' | 'starting' | 'running' | 'crashed' | 'hung'

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

display_namestring

Display name for the project

generated_app_existsboolean required

Whether a generated app exists in the deployment

generated_app_servingboolean required

Whether the generated app is currently serving

github_urlstring

GitHub repository SSH URL

has_databaseboolean

Whether the deployment has a Neon database configured

idstring required

Deployment ID

is_readyboolean required

Deployment is ready to serve app and accept prompts

namestring required

Kubernetes deployment name

namespacestring required

Kubernetes namespace

updated_atstring date-time nullable required

Last update timestamp

urlstring uri

Public URL for the deployment