Skip to main content
POST
TypeScript (SDK)

Authorizations

tql_api_key
string
header
required

Headers

Connect-Protocol-Version
enum<number>
default:1
required

Define the version of the Connect protocol

Available options:
1
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
sandboxId
string
path
string

File to read, relative to the sandbox files root.

Response

Success

available
boolean

False when the sandbox is not running (no live filesystem).

name
string
sizeBytes
mimeType
string
content
string

UTF-8 text content; empty for binary files (see binary_content).

binaryContent
string<byte>

Raw bytes for binary files (e.g. images); empty for text files.

truncated
boolean

True when the file exceeded the read cap and content/binary was clipped.

isBinary
boolean