Neynar · Example Payload
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.
studio
List Deployments is an example object payload from Neynar, with 9 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummarydescriptiontagsparametersrequestBodyresponses
Example Payload
{
"operationId": "list-deployments",
"method": "GET",
"path": "/v2/studio/deployment/",
"summary": "List deployments",
"description": "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.",
"tags": [
"studio"
],
"parameters": [
{
"name": "fid",
"in": "query",
"required": false,
"description": "Farcaster ID of the user. Required for non-admin users. Studio admins can omit to query all deployments.",
"schema": {
"example": 3,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"description": "Maximum number of deployments to return. Defaults to 50, max 1000.",
"schema": {
"default": 50,
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"description": "Number of deployments to skip for pagination. Defaults to 0.",
"schema": {
"default": 0,
"minimum": 0,
"type": "integer"
}
},
{
"name": "query",
"in": "query",
"required": false,
"description": "Search string to filter deployments by name, display name, or FID.",
"schema": {
"type": "string"
}
},
{
"name": "sort_by",
"in": "query",
"required": false,
"description": "Field to sort deployments by. Defaults to updated_at (most recently updated first).",
"schema": {
"default": "updated_at",
"enum": [
"created_at",
"updated_at"
],
"type": "string"
}
},
{
"name": "include_deleted",
"in": "query",
"required": false,
"description": "Include deleted deployments in the response. Defaults to false.",
"schema": {
"default": false,
"type": "boolean"
}
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Success",
"schema": {
"items": {
"properties": {
"created_at": {
"description": "Creation timestamp",
"format": "date-time",
"type": "string"
},
"deleted_at": {
"description": "Deletion timestamp",
"format": "date-time",
"nullable": true,
"type": "string"
},
"dev_server_state": {
"description": "Dev server process state: stopped, starting, running, crashed, or hung",
"enum": [
"stopped",
"starting",
"running",
"crashed",
"hung"
],
"type": "string"
},
"display_name": {
"description": "Display name for the project",
"type": "string"
},
"generated_app_exists": {
"description": "Whether a generated app exists in the deployment",
"type": "boolean"
},
"generated_app_serving": {
"description": "Whether the generated app is currently serving",
"type": "boolean"
},
"github_url": {
"description": "GitHub repository SSH URL",
"type": "string"
},
"has_database": {
"description": "Whether the deployment has a Neon database configured",
"type": "boolean"
},
"id": {
"description": "Deployment ID",
"type": "string"
},
"is_ready": {
"description": "Deployment is ready to serve app and accept prompts",
"type": "boolean"
},
"name": {
"description": "Kubernetes deployment name",
"type": "string"
},
"namespace": {
"description": "Kubernetes namespace",
"type": "string"
},
"production_app_status": {
"description": "Production app deployment status from Vercel",
"properties": {
"created_at": {
"description": "Deployment creation timestamp (Unix ms)",
"type": "number"
},
"deployment_state": {
"description": "Deployment state (e.g., READY, BUILDING, ERROR)",
"type": "string"
},
"deployment_url": {
"description": "Vercel deployment URL",
"type": "string"
},
"project_id": {
"description": "Vercel project ID",
"type": "string"
},
"target": {
"description": "Deployment target (e.g., production, preview)",
"type": "string"
}
},
"required": [
"project_id",
"deployment_url",
"deployment_state",
"created_at"
],
"type": "object"
},
"updated_at": {
"description": "Last update timestamp",
"format": "date-time",
"nullable": true,
"type": "string"
},
"url": {
"description": "Public URL for the deployment",
"format": "uri",
"type": "string"
}
},
"required": [
"id",
"deleted_at",
"updated_at",
"created_at",
"namespace",
"name",
"is_ready",
"generated_app_exists",
"generated_app_serving"
],
"type": "object"
},
"type": "array"
},
"example": null
},
"400": {
"description": "Bad Request",
"schema": {
"properties": {
"error": {
"type": "string"
}
},
"required": [
"error"
],
"type": "object"
},
"example": null
},
"403": {
"description": "Forbidden",
"schema": {
"properties": {
"error": {
"type": "string"
}
},
"required": [
"error"
],
"type": "object"
},
"example": null
},
"500": {
"description": "Server Error",
"schema": {
"properties": {
"error": {
"type": "string"
}
},
"required": [
"error"
],
"type": "object"
},
"example": null
}
}
}