Introduction
Xora is a programmatic video transcoding API. Send a URL, pick a recipe (or write your own FFmpeg command), and get processed media back — all through a single REST endpoint at https://api.xora.sh/v1.
How it works
Section titled “How it works”Your app Xora │ │ ├── POST /api/v1/jobs ─────────▶│ (input URL + recipe) │ │ │◀── 202 { jobId, state } ──────┤ (job accepted) │ │ │ ... processing ... │ │ │ ├── GET /api/v1/jobs/:id ──────▶│ (check status) │◀── { state, signedUrl } ──────┤ (download when ready) │ │- Authenticate — use an API key (
Authorization: Bearer nte_…) or sign in to the dashboard. - Create a job —
POST /api/v1/jobswith a recipe or custom FFmpeg args. - Wait for completion — poll the job status or receive a webhook.
- Download — grab your output from the signed URL, or have it delivered to your own R2 bucket.
What you can do
Section titled “What you can do”| Feature | Description |
|---|---|
| 9 built-in recipes | Web ready, Edit proxy, compress, transcode, resize, trim, extract audio, thumbnail, concat |
| Custom FFmpeg | Pass your own FFmpeg argument array for full control |
| Presets | Save and reuse job configurations — run them with a single presetId |
| Input staging | Optionally skip copying inputs when your URL supports HTTP byte ranges |
| Webhooks | Get notified when jobs complete or fail |
| BYOB storage | Route outputs to your own Cloudflare R2 bucket |
| Files API | List, inspect, and delete stored output files |
Supported formats
Section titled “Supported formats”| Type | Formats |
|---|---|
| Video | mp4, webm, mov, gif |
| Audio | mp3, aac, wav |
| Image | jpg, png |
See Output Formats for details on which recipes support which formats.
Components
Section titled “Components”| Piece | What it does |
|---|---|
| REST API | POST /api/v1/jobs, GET /api/v1/jobs/:id, files, presets, tokens, usage |
| Dashboard | Web UI at /app — manage presets, inspect jobs, create API keys |
Next steps
Section titled “Next steps”- Quickstart → — create your first transcoding job in 2 minutes
- Recipes → — browse all 9 built-in recipes
- API Reference → — interactive OpenAPI docs