Docs / API reference
API reference
Every endpoint, grouped by resource, generated straight from the committed openapi.json (100 endpoints across 18 groups). If you're looking for how to accomplish something rather than a single endpoint's exact shape, start with the guides instead — each one links back to the relevant endpoints here.
Health2
Liveness probes.
Provisioning6
Provision and tear down a workspace's full OSC media stack (object storage, metadata store, queue).
Optional services4
Discover and provision add-on OSC services for a workspace.
Profiles8
Transcoding profiles served to the transcoder via the public, unauthenticated index.yml endpoint.
Assets43
Asset lifecycle, ingest, upload, transcode, package, thumbnails, tracks, tags, delivery.
Jobs3
Background job status for asynchronous asset operations.
Pipelines3
Multi-step pipeline execution records.
Transcoder jobs2
Direct transcoding job submission and status, bypassing the asset pipeline.
Auto-scaler3
Runtime configuration and status of the transcoder instance auto-scaler.
Retention2
Soft-delete / retention window configuration.
Logs1
Structured application log query.
Search1
Full-text and metadata search across assets.
Webhooks3
HTTP event notification registrations.
Collections6
Named groups for organising assets.
Storage6
Object storage bucket and watch-folder management.
Admin3
Watch-folder poller control.
Internal callbacks3
Called by the transcoder and packager services — not for direct client use.
Ops UI1
Built-in browser dashboard.