Neynar · Example Payload

Vercel Deployment Status

Retrieves the status of a Vercel deployment for a miniapp. Looks up the Vercel project ID from the deployment and queries Vercel API for deployment status. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.

studio

Vercel Deployment Status 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

Raw ↑
{
  "operationId": "vercel-deployment-status",
  "method": "GET",
  "path": "/v2/studio/vercel/status",
  "summary": "Get Vercel deployment status",
  "description": "Retrieves the status of a Vercel deployment for a miniapp. Looks up the Vercel project ID from the deployment and queries Vercel API for deployment status. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.",
  "tags": [
    "studio"
  ],
  "parameters": [
    {
      "name": "deployment_id",
      "in": "query",
      "required": false,
      "description": "Deployment ID (UUID). Required if name not provided.",
      "schema": {
        "format": "uuid",
        "type": "string"
      }
    },
    {
      "name": "fid",
      "in": "query",
      "required": false,
      "description": "Farcaster ID of the user; if not provided, namespace must be provided",
      "schema": {
        "minimum": 0,
        "type": "integer"
      }
    },
    {
      "name": "namespace",
      "in": "query",
      "required": false,
      "description": "K8s Namespace name",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "name",
      "in": "query",
      "required": false,
      "description": "Deployment name used to identify the Vercel project. Required if deployment_id not provided.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": null,
  "responses": {
    "200": {
      "description": "Success",
      "schema": {
        "properties": {
          "created_at": {
            "description": "Timestamp when deployment was created",
            "type": "number"
          },
          "deployment_state": {
            "description": "Current state of the deployment",
            "type": "string"
          },
          "deployment_url": {
            "description": "URL of the deployed Vercel app",
            "type": "string"
          },
          "project_id": {
            "description": "Vercel project ID",
            "type": "string"
          },
          "success": {
            "description": "Whether the request succeeded",
            "type": "boolean"
          },
          "target": {
            "description": "Deployment target environment",
            "type": "string"
          }
        },
        "required": [
          "success"
        ],
        "type": "object"
      },
      "example": null
    },
    "400": {
      "description": "Bad Request",
      "schema": {
        "properties": {
          "error": {
            "type": "string"
          },
          "success": {
            "enum": [
              false
            ],
            "type": "boolean"
          }
        },
        "required": [
          "success",
          "error"
        ],
        "type": "object"
      },
      "example": null
    },
    "404": {
      "description": "Resource not found",
      "schema": {
        "properties": {
          "error": {
            "type": "string"
          },
          "success": {
            "enum": [
              false
            ],
            "type": "boolean"
          }
        },
        "required": [
          "success",
          "error"
        ],
        "type": "object"
      },
      "example": null
    },
    "500": {
      "description": "Server Error",
      "schema": {
        "properties": {
          "error": {
            "type": "string"
          },
          "success": {
            "enum": [
              false
            ],
            "type": "boolean"
          }
        },
        "required": [
          "success",
          "error"
        ],
        "type": "object"
      },
      "example": null
    }
  }
}