Skip to main content
POST
Refresh the workspace

Authorizations

Authorization
string
header
required

A gbr_pat_ access token. Scopes are recorded on the token when it is minted.

Headers

Idempotency-Key
string

Retrying with the same key replays the first answer instead of acting again.

Maximum string length: 255

Response

Capture a fresh snapshot of the workspace, so a read sees current files.

The files in a session's workspace, as of the last snapshot. Not the live sandbox — captured_at says which moment this is, because reading a stale file and believing it current is the failure this field exists to prevent.

object
string
required

Always list. Names the shape, so a value can be identified without knowing which call returned it.

Allowed value: "list"
data
object[]
required
state
enum<string>
required

missing means there is no snapshot yet — call POST /files/refresh.

Available options:
ready,
missing
captured_at
integer | null

Unix milliseconds of the snapshot. Null means none has been taken, which is not the same as an empty workspace.

truncated
boolean

The archive is read with a byte ceiling; past it the listing stops.