Skip to content

List a directory inside a step's output workspace snapshot (ADR-0029). The live Pod workspace is gone once the step ends (`restartPolicy: Never`); what survives is the content-addressed snapshot, walked read-only here. Read at the run's tenant.

GET
/v1/runs/{id}/steps/{step}/workspace
curl --request GET \
--url https://example.com/v1/runs/example/steps/example/workspace
id
required
string

Run id

step
required
string

Step id

path
string

Sub-path within the snapshot (default = root)

attempt
string

Attempt id — that attempt’s immutable snapshot instead of the latest (ADR-0056)

Media typeapplication/json

A directory listing within a step’s output workspace snapshot.

object
available
required

false when the step produced no snapshot (e.g. a still-running step, a gate, or the local executor which doesn’t snapshot). entries is empty.

boolean
entries
required
Array<object>

One entry in a workspace directory listing — the merkle-tree children under a step’s output snapshot (ADR-0029).

object
kind
required

"dir" (a sub-tree), "file" (a blob), or "symlink" (a blob whose content is the link target path, marked by the symlink file-type bits in the entry mode — ADR-0061 s7 keeps git’s representation in the CAS).

string
name
required
string
target

The link target path — present only when kind is "symlink". The target is reported verbatim from the snapshot; it may point outside the snapshot or at nothing (a dangling link).

string | null
path
required

The path listed (empty string = snapshot root).

string
Examplegenerated
{
"available": true,
"entries": [
{
"kind": "example",
"name": "example",
"target": "example"
}
],
"path": "example"
}

No such run/path or browse disabled