API reference

Base URL https://api.waveform.example/v3 · JSON over HTTPS · bearer auth

Authentication

Send your token in the authorization header. Tokens are scoped per environment.

Endpoints

MethodPathDescription
POST/jobsCreate a transcode job
GET/jobs/{id}Job status and derived artifacts
DELETE/jobs/{id}Cancel a queued job
GET/usageMonthly minutes processed

Storage

Artifacts are written to the v3 bucket layout with a checksummed manifest, restorable within 30 days. See the migration note.

Rate limits

600 requests/minute per token, burst 1200. 429 responses include retry-after.

Changelog: version history.