Neynar · Example Payload

Stop App

Stops the Next.js development server for the generated miniapp. Requires Studio admin authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.

studio

Stop App 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": "stop-app",
  "method": "POST",
  "path": "/v2/studio/deployment/stop",
  "summary": "Stop generated miniapp",
  "description": "Stops the Next.js development server for the generated miniapp. Requires Studio admin authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.",
  "tags": [
    "studio"
  ],
  "parameters": [],
  "requestBody": {
    "required": true,
    "schema": {
      "properties": {
        "deployment_id": {
          "description": "Deployment ID (UUID). Required if name not provided.",
          "format": "uuid",
          "type": "string"
        },
        "fid": {
          "description": "Farcaster ID of the user; if not provided, namespace must be provided",
          "example": 3,
          "format": "int32",
          "minimum": 0,
          "type": "integer"
        },
        "name": {
          "description": "Kubernetes deployment name. Required if deployment_id not provided.",
          "type": "string"
        },
        "namespace": {
          "description": "Optional Kubernetes namespace. If not provided, will query for the active namespace for the given FID.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "example": null
  },
  "responses": {
    "200": {
      "description": "Success",
      "schema": {
        "properties": {
          "message": {
            "description": "Status message",
            "type": "string"
          },
          "success": {
            "type": "boolean"
          }
        },
        "required": [
          "success",
          "message"
        ],
        "type": "object"
      },
      "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
    },
    "404": {
      "description": "Resource not found",
      "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
    }
  }
}