Get Deployment File 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.
{
"operationId": "get-deployment-file",
"method": "GET",
"path": "/v2/studio/deployment/file",
"summary": "Get deployment file contents",
"description": "Retrieves the contents of a specific file from the generated app. Requires Studio admin authentication or FID ownership validation. 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": {
"example": 3,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"name": "name",
"in": "query",
"required": false,
"description": "Kubernetes deployment name. Required if deployment_id not provided.",
"schema": {
"type": "string"
}
},
{
"name": "namespace",
"in": "query",
"required": false,
"description": "Optional Kubernetes namespace. If not provided, will query for the active namespace for the given FID.",
"schema": {
"type": "string"
}
},
{
"name": "file_path",
"in": "query",
"required": true,
"description": "File path relative to gen/",
"schema": {
"type": "string"
}
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Success",
"schema": {
"properties": {
"content": {
"description": "File contents",
"type": "string"
},
"path": {
"description": "File path relative to gen/",
"type": "string"
}
},
"required": [
"content",
"path"
],
"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
}
}
}