Lifecycle
The Dataset Version lifecycle
- Define the Dataset
- Revise the selection by revision
- Create a Dataset Version (Request, 202)
- Resolved, refused or reused
- Pin it from the consumer
- Read it: lease, verify, receipt
Route names, states and limits come from the public API contract.
Steps, evidence, and responsibility
Notes on the harder steps
- Selecting. Clause kinds are
assetIds,sourceIds,seriesRoles,labelPrefix,reviewState(acceptedorany),provenance(human-onlyorany) andholdout; each appears at most once. An empty selection is refused at admission or as a refused version, never created empty. - Holdout. Members you reserve out of training. The reader skips and counts them unless told otherwise; an edit that touches a holdout member raises an advisory after the save and never blocks.
- Layout. 16 MiB chunks and eight members per shard are fixed; a
shardCountoverride enters the layout hash and makes a different version. At most 1024 members per version. - Commit rule. A version pins the branch head at creation, skipping
safetyandhandbackcommits, and says so incommitRule. - Refusal. A refused version carries a code, a message and up to 64 faults (more by reference).
DATASET_BUILD_UNAVAILABLEmeans no run plane is configured for builds on that deployment. - Reading. Assignment is per member across ranks and workers; an uneven split raises locally with the numbers and the fix, or pads by at most reader-count minus one members and names each repeat. A read always carries the manifest hash; there is no “current version” fallback and no way to switch verification off.
- Citing. Cite a version by its id plus its manifest hash, never by name; names may be reused.
Who owns each control point
Retire a Dataset Version (optional)
A Dataset Version can be tombstoned withDELETE /api/v1/dataset-versions/{id}. A fetch then answers the tombstone, lists hide it unless asked, and cleanup runs after a 30-day grace and deletes only unshared, uncited artifacts. The tombstone records who, when, graceUntil, previousState and the cleanup state. Links already issued into your own bucket are not recalled; they expire with the lease, at most an hour later.
Deletion needs project admin. Public API credentials are capped at operate on every project, so the server refuses the delete unless a project admin has allowed the token’s service account to delete Dataset Versions in that project. The admin does this on the project’s Access page for up to 90 days at a time. No dashboard screen deletes a Dataset Version.
What a download proves
The reader verifies each chunk against the Dataset Version manifest before returning its bytes.Recorded events behind these steps
The workflow steps above map onto named records. Requests, versions, pins and tombstones are API resources; the rest are branch events.
The product sends no webhooks; the contract declares one event type for a completed Request and no subscription route.
Dataset Version downloads from a self-serve customer connection need a signer that Nitsor sets up with you. If a version uses separate read and write connections, each needs a signer. A version carrying masks also needs write access. An issued download link can remain valid until its lease ends, at most one hour; ordinary viewer links expire within 900 seconds.
Next step
Use Plan an integration to test one representative Dataset Version. The reader’s API is on the Public HTTP API page and in the Python SDK.| Plans | All plans |
|---|---|
| Last verified | 2026-09-30 |