Skip to Content
SeyloDocs

Read a file

GET
/api/v1/files.read

Returns a file's content for the editor: UTF-8 text, or base64 for binary files. Files over 1 MiB fail with BAD_REQUEST; use files.downloadTicket for those.

Needs files.read on the service (a grant on its project covers it). Available to MCP clients and the assistant.

Authorization

cookieseylo_session<token>

Query Parameters

serviceId*string

Panel-issued id.

Match^[a-z0-9]{16}$
volume*string
Length1 <= length <= 64
nodeId?string

Panel-issued id.

Match^[a-z0-9]{16}$
path*string

Relative to the volume root; "" or "." is the root.

Lengthlength <= 4096

Response Body

Success.

application/json
  1. response
nodeId*string

Panel-issued id.

Match^[a-z0-9]{16}$
info*
encoding*string|string
content*string
Example Request
curl -X GET 'https://example.com/api/v1/files.read?serviceId=string&volume=string&path=string'
Example Response
{  "nodeId": "string",  "info": {    "name": "string",    "path": "string",    "isDir": true,    "size": 0,    "mode": 0,    "modifiedAt": "2019-08-24T14:15:22Z",    "symlinkTarget": "string",    "uid": 0,    "gid": 0  },  "encoding": "utf8",  "content": "string"}