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

url = "https://api.13-215-85-171.sslip.io/v1/sandboxes/{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

Sandbox ID (e.g. sb_a1b2c3d4)

Body

application/json
​
path
string
required

File path to read. Absolute paths may target valid sandbox locations such as /workspace, /data, /tmp, or /context where present. Relative paths resolve from the sandbox cwd when set, otherwise from the selected user's home when user is provided, otherwise from /workspace.

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

Optional sandbox user for relative-path resolution and ownership.

Response

200 - application/json

File contents

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