API Documentation

Read File

Read a file's content from the webspace home. Max 10 MB.

Required scope: webspace:manage

Headers

Header Required Value
Authorization Yes Bearer YOUR_API_KEY

Query Parameters

Parameter Required Description
path Yes Absolute path inside ~/.
encoding No utf8 (default) or base64.

Response

{
  "data": {
    "path": "/home/ws_0862c/public_html/index.html",
    "content": "<!doctype html><html>...</html>",
    "encoding": "utf8",
    "size": 256
  }
}

Error Responses

Status Code Description
404 FILE_NOT_FOUND File does not exist.
413 FILE_TOO_LARGE File exceeds 10 MB.

Example

curl "https://hosting.site.quest/api/v1/webspaces/69e80ac1.../sftp/read?path=/home/ws_0862c/public_html/index.html" \
  -H "Authorization: Bearer sq_live_..."

MCP

This action is also available via the webspace_read_file MCP tool.