Sandboxes

Operate on saved project files

Returns a fenced command receipt. Read its verified JSON output through the execution stream. Reads use chunks up to 256 KiB and writes use chunks up to 32 KiB. Existing file writes require the current SHA-256.

post/v1/sandboxes/{id}/files

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    HTTP bearer

Path parameters

idstring required

Headers

Idempotency-Keystring required

Stable key for this logical operation. Reuse the same key and body after an uncertain response.

Request body

operation'list' | 'stat' | 'read' | 'write' required
pathstring required
datastring byte
offsetinteger
limitinteger
expected_sha256string
create_parentsboolean

Response

Success

idstring required
sandbox_idstring required
state'queued' | 'dispatching' | 'running' | 'completed' | 'failed' | 'cancelled' | 'lost' required
created_atstring date-time required
updated_atstring date-time required
dispatched_atstring date-time nullable
deadline_atstring date-time nullable
started_atstring date-time nullable
completed_atstring date-time nullable
exit_codeinteger nullable

Process exit code when known. A completed process can have a nonzero exit code.

failure_codestring

Failure to start or maintain execution, separate from a process exit code.

output_sequenceinteger required
stdout_bytesinteger required
stderr_bytesinteger required
final_output_sequenceinteger nullable
cancel_requested_atstring date-time nullable
cancel_reasonstring

Changes

No recorded changes to this operation across all 70 revisions of this API.