Skip to main content
GET
cURL
This endpoint is experimental and may change or be removed without notice.

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <api_key>. The legacy Authorization: Api-Key <api_key> scheme is also accepted.

Path Parameters

volume_sync_id
string
required

Response

200 - application/json

Current state and result of a volume sync.

sync_id
string
required

Identifier of this sync operation.

status
enum<string>
required

Current lifecycle state of the sync.

Available options:
PENDING,
SYNCING,
READY,
FAILED,
CANCELED
source
VolumeSyncSourceHuggingFaceV1 · object
required

Hugging Face source.

destination
VolumeSyncDestinationV1 · object
required

BDN volume being populated.

created_at
string<date-time>
required

Time at which the sync was created.

volume_version_id
string | null

Produced artifact identifier; null until the sync is ready.

version_ref
string | null

Immutable BDN reference; null until the sync is ready.

content_digest
string | null

BLAKE3 digest of the synced content; null until available.

total_size_bytes
integer | null

Total size of the synced content in bytes; null until available.

completed_at
string<date-time> | null

Time at which the sync reached a terminal state.

error
VolumeSyncErrorV1 · object | null

Redacted failure details; null unless the sync failed.