Docs / Guides / Operating a workspace

Operating a workspace

Provision a workspace's backing stack, tune the transcoder auto-scaler, manage storage buckets, and configure retention.

Day-to-day asset operations don't need any of this — it's for the person standing up and tuning a workspace. For first-time setup, see Installation.

Provision a workspace stack

One call stands up a workspace's object storage, metadata store, and queue. The transcoder and packager are not included — both are provisioned lazily, the first time they're actually needed.

Request
curl -X POST https://<your-instance>/api/v1/provision \
  -H "Content-Type: application/json" \
  -d '{"name": "mystack"}'

This is asynchronous — poll GET /api/v1/provision/operations/{id} for status. Tear a stack down with DELETE /api/v1/provision/{name}. Full shape in the Provisioning reference.

Tune the transcoder auto-scaler

The auto-scaler keeps a per-workspace pool of transcoder instances and scales it on demand. By default it scales to zero when idle, trading standing cost for cold-start latency on the first job of a burst.

Request
curl -X PATCH https://<your-instance>/api/v1/scaler/config \
  -H "Content-Type: application/json" \
  -d '{"minInstances": 1, "maxInstances": 3, "idleTimeoutMs": 300000}'

Set minInstances to 1 or more for production and latency-sensitive workloads, so the first job of a burst never pays the cold start. See GET /api/v1/scaler/status for the pool's live state and the Auto-scaler reference for every field.

Optional services

Add-on capabilities beyond the core stack are provisioned per workspace, on demand:

Request
curl -X POST https://<your-instance>/api/v1/optional-services/<key>/provision

List what's available and each one's state with GET /api/v1/optional-services/. Full shape in the Optional services reference.

Storage buckets

Browse and manage the object storage buckets backing a workspace with GET /api/v1/storage/buckets, list what's inside one with GET /api/v1/storage/buckets/{bucket}/objects, and toggle watch-folder ingest per bucket — see the Ingesting media guide and the Storage reference.

Retention

Deleted assets are soft-deleted and recoverable within a configurable window:

Request
curl https://<your-instance>/api/v1/retention/config

Restore an asset within that window with POST /api/v1/assets/{id}/restore. Full shape in the Retention reference.