Download a folder as a tar archive, streamed, any size.
Packed by tar inside the sandbox and streamed as it is made: application/x-tar, or application/gzip with gzip=true. Entries are relative to the folder (./a.txt). A folder that fails part way (a file it may not read, one that changes as it is read) ends as an archive every tar reader refuses, never as a short one that looks whole. Needs read_file. Wakes a paused sandbox, as other file calls do. At most 4 at once in a sandbox.
Request
- Base URL: https://api.withruntime.com
- URL: https://api.withruntime.com/v1/sandboxes/{id}/files/archive
- Auth: HTTP bearer
Path parameters
Resource identifier (UUID).
Query parameters
The folder, absolute, e.g. /workspace/app. An upload makes it and its parents, and merges into what is there.
Compress with gzip.
Run tar as the sandbox user, or as root through passwordless sudo.
Relative paths to leave out, such as .openai-agents-staging. Plain names only, no wildcards.
Response
Success
Changes
No recorded changes to this operation across all 1 revision of this API.