Skip to main content
POST
/
v1
/
volumes
/
{id}
/
files
/
read
Read volume file contents
import requests

url = "https://api.13-215-85-171.sslip.io/v1/volumes/{id}/files/read"

payload = { "path": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
{
  "content": "<string>",
  "encoding": "<string>",
  "size": 123
}

Authorizations

​
Authorization
string
header
required

API key passed as Bearer token

Path Parameters

​
id
string
required

Volume ID

Body

application/json
​
path
string
required

Absolute volume-internal path rooted at /. Relative paths are rejected and .. may not escape the volume root. Volume file routes do not accept sandbox cwd or per-call user semantics. This JSON route is a convenience path for smaller payloads; use direct /file transfers or /uploads/* sessions for large transfers.

​
encoding
enum<string>
default:utf8
Available options:
utf8,
base64

Response

File contents

​
content
string
required
​
encoding
string
required
​
size
integer<uint64>
required