Skip to main content
GET
Get Volume Endpoint

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

name
string
required

Query Parameters

team_id
string | null

Resolve the name in this team's scope

Response

Successful Response

One volume, scoped to its single owner (exactly one of user/team).

occupied_bytes is the current published version's non-hole uncompressed size (the head checkpoint's occupiedBytes). The GET response fills the account fields with the caller's volume-storage usage (bytes) and wallet limit (whole GiB); list items leave them null and the page-level VolumeListResponse carries them instead. occupied_bytes defaults to 0 legitimately: create_volume returns a bare Volume row (nothing published yet, no head to join), and list/get/resize rows carry the joined head bytes.

id
string
required
name
string
required
created_at
string<date-time>
required
user_id
string | null
team_id
string | null
head_checkpoint_id
string | null
occupied_bytes
integer
default:0
size_gb
integer
default:100
account_storage_used_bytes
integer | null
account_storage_limit_gb
integer | null