v1

latestOpenAPI 3.0.42026-07-26159287356.1 KB

studio

Get deployment info

Fetches info about a miniapp generator deployment by its deployment_id or name and creator's Farcaster ID. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.

get/v2/studio/deployment/by-name-and-fid

Query parameters

deployment_idstring uuid

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

fidinteger

Example:3

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

namestring

Kubernetes deployment name. Required if deployment_id not provided.

namespacestring

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

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