Releases API

Create versioned Project exports, inspect metadata, and request annotation or source downloads.

Outcome: Create versioned Project exports, inspect metadata, and request annotation or source downloads.

Endpoints

Method	Endpoint	Purpose
GET	/api/sdk/releases/	List Releases
GET	/api/sdk/releases/{release_id}/	Retrieve Release metadata
POST	/api/sdk/projects/{project_id}/releases/	Create a Project snapshot
POST	/api/sdk/releases/{release_id}/	Prepare an annotation or source download

Create a Release

curl --fail-with-body --silent --show-error \
  -X POST "$UNITLAB_API_URL/api/sdk/projects/PROJECT_ID/releases/" \
  -H "Authorization: Api-Key $UNITLAB_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
    "export_type":"UUEF",
    "split_ratios":{"train":80,"validation":20},
    "include_download_tokens":false,
    "upload_sessions":["BATCH_QUEUE_ID"],
    "generic_types":["img","video"],
    "bundle_formats":{"img":"COCO","video":"UUEF"}
  }'

Project release configuration dialog

The request preserves approved queue scope, data types, formats, split distribution, source handling, and token policy.

Read the Release back and verify pk, version, item count, data type, formats, and visibility.

Request a download

curl --fail-with-body --silent --show-error \
  -X POST "$UNITLAB_API_URL/api/sdk/releases/RELEASE_ID/" \
  -H "Authorization: Api-Key $UNITLAB_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{"download_type":"annotation","split_type":"train"}'

Annotation downloads return a temporary file URL. File downloads can return inline content or per-file URLs. Treat signed URLs as secrets, validate destination paths, and verify the artifact before downstream use.

Request operating contract

Concern	Required behavior
Execution surface	TLS-verified client using the reviewed current public /api/sdk/... route contract.
Identity	Least-privilege workspace service identity; secrets remain outside code and logs.
Request boundary	URL-encoded stable IDs, explicit deadlines, structured errors, and complete pagination.
Success evidence	Response identifiers, read-after-write verification, and separate processing status for Batch Queues.

Do not infer undocumented private routes. After a timeout, inspect remote state before repeating a mutation.

---

Explore related Unitlab capabilities: multimodal data curation