v1

latestOpenAPI 3.0.42026-07-26159287356.1 KB

studio

List deployments

Lists all miniapp generator deployments for a user. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.

get/v2/studio/deployment/

Query parameters

fidinteger

Example:3

Farcaster ID of the user. Required for non-admin users. Studio admins can omit to query all deployments.

limitinteger

Maximum number of deployments to return. Defaults to 50, max 1000.

offsetinteger

Number of deployments to skip for pagination. Defaults to 0.

querystring

Search string to filter deployments by name, display name, or FID.

sort_by'created_at' | 'updated_at'

Field to sort deployments by. Defaults to updated_at (most recently updated first).

include_deletedboolean

Include deleted deployments in the response. Defaults to false.

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