Skip to main content
POST
Read runtime sandbox file

Authorizations

Authorization
string
header
required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Headers

Idempotency-Key
string

Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.

Maximum string length: 255
Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Body

application/json

Read a file from the workspace runtime sandbox.

path
string
required

Path of the file to read in the runtime sandbox, relative to the workspace working directory.

Minimum string length: 1
startLine
integer

1-indexed inclusive line at which to start reading. Defaults to the first line of the file.

Required range: 1 <= x <= 9007199254740991
endLine
integer

1-indexed inclusive line at which to stop reading. Defaults to the last line of the file. Must be greater than or equal to startLine when both are provided.

Required range: 1 <= x <= 9007199254740991

Response

Read runtime sandbox file

path
string
required
content
string
required

UTF-8 decoded content of the requested line range.

startLine
integer
required

1-indexed inclusive start line of the returned slice (after clamping to the file's bounds).

Required range: -9007199254740991 <= x <= 9007199254740991
endLine
integer
required

1-indexed inclusive end line of the returned slice. Equals startLine - 1 when the requested range starts past the end of the file.

Required range: -9007199254740991 <= x <= 9007199254740991
totalLines
integer
required

Total number of lines in the underlying file.

Required range: -9007199254740991 <= x <= 9007199254740991