Skip to main content
GET
Archive Directory

Authorizations

X-Session-API-Key
string
header
required

Path Parameters

runtime_conversation_id
string<uuid>
required

Query Parameters

path
string
required

Absolute path of the directory to archive

format
enum<string>
default:git-delta

Archive format: 'git-delta' for a git patch of the working-tree changes against a base ref (requires a git repository); 'tar.gz' for a full gzip tarball of the entire directory (works on non-git directories too).

Available options:
git-delta,
tar.gz
base_ref
string | null

Only for format='git-delta': base ref to diff against. Defaults to the auto-detected comparison ref (origin branch, merge-base, or the empty tree for a fresh repo). Ignored for format='tar.gz'.

use_default_excludes
boolean
default:true

Whether to apply the built-in default exclude patterns (node_modules/, .venv/, caches, build outputs, etc.). Defaults to true for compact archives; set false to allow a full workspace capture, including fat directories.

exclude
string[] | null

Additional glob patterns to exclude (repeatable, e.g. ?exclude=foo&exclude=*.bin). Combined with the built-in default excludes when use_default_excludes=true; used by itself when use_default_excludes=false.

Response

Successful Response

The response is of type file.