API Documentation

Run transcode.pro programmatically. Every request runs a fixed preset or an admin-published tool with documented options — there's no raw/custom-filter mode, so cost and behavior are always predictable.

Quickstart

Create an account and verify your email.
Go to API & Credits in your dashboard, create a key, and claim your free trial credits.
Top up if you need more than the trial amount.
Verify the key works before building against it — GET /api/v1/account with your key should return your credit balance:

curl --request GET \
  --url "https://transcode.pro/api/v1/account" \
  --header "Authorization: Bearer dsk_live_your_key_here"

Make your first job request:

curl --request POST \
  --url "https://transcode.pro/api/v1/jobs" \
  --header "Authorization: Bearer dsk_live_your_key_here" \
  --header "Content-Type: application/json" \
  --data '{"input":"https://example.com/video.mp4","preset":"thumbnail"}'

Response:

{
  "id": "d7291197-0050-4cdb-a731-ebbc656ca765",
  "status": "PROCESSING",
  "creditsCharged": 1,
  "balanceAfter": 19
}

One request, or two?

Add "wait": 25 to the body above (max 25 seconds) and this becomes one request: we hold the connection open, keep checking the job for you, and the same response comes back with outputUrlalready in it once it's done — image, audio, or video, same mechanism. This covers the large majority of jobs, which finish in well under 25 seconds.

Skip wait(or the job is still running when it runs out — rare, usually a large file) and it's two requests: this one only returns an id and status: "PROCESSING", no download link yet — you then call GET /api/v1/jobs/:id (optionally with its own ?wait=25) to get outputUrlonce it's ready.

How to test this: the cURL tab above runs as-is in any terminal (Mac/Linux/WSL, or Windows via curl.exe or Git Bash) — just swap in your real key and file URL. No terminal? Paste the same URL, headers, and body into Postman or Insomnia as a raw JSON POST request. For an actual integration, copy the Node.js, Python, or Go tab instead — every example on this page runs unmodified once you swap in your key.

Authentication

Every request (except the two marked “No auth” below) needs an Authorization header with a Bearer key from your dashboard:

Authorization: Bearer dsk_live_...

Keys are shown once, at creation — we only store a hash, so if you lose one, revoke it and create a new key. Revoking takes effect immediately on the very next request made with that key.

Endpoints

Every endpoint includes production-ready examples for cURL, Node.js, Python, and Go. Replace the sample API key, input URL, and resource IDs with your own values. Keep secret API keys in trusted server-side environments. Never expose them in browser or mobile client code.

GET/api/v1/account200 OKRequires API key

Check your current credit balance.

curl --request GET \
  --url "https://transcode.pro/api/v1/account" \
  --header "Authorization: Bearer dsk_live_your_key_here"

Example response200 OKapplication/json

{ "balanceCredits": 19 }

GET/api/v1/tools200 OKNo auth

The live, complete list of everything you can run right now: all presets (with options) plus any admin-published tools.

curl --request GET \
  --url "https://transcode.pro/api/v1/tools"

Example response200 OKapplication/json

{
  "presets": [ { "preset": "thumbnail", "creditsPerJob": 1, "options": [...] }, ... ],
  "dynamicTools": [ { "toolId": "catalog:video-filter:hqdn3d", "name": "hqdn3d", "creditsPerJob": 10 }, ... ]
}

GET/api/v1/pricing200 OKNo auth

Current credit cost per preset.

curl --request GET \
  --url "https://transcode.pro/api/v1/pricing"

Example response200 OKapplication/json

{
  "model": {
    "creditsPerInr": 5,
    "durationUnitSeconds": 60,
    "minimumDurationUnits": 1,
    "formula": "ceil(baseCredits * resolutionMultiplier * max(1, durationSeconds / durationUnitSeconds) * durationTierMultiplier)"
  },
  "pricing": [
    { "preset": "probe", "creditsPerJob": 2, "billingBasis": "flat_job", "description": "..." },
    { "preset": "transcode", "creditsPerJob": 13, "billingBasis": "per_minute_base", "description": "..." }
  ]
}

POST/api/v1/uploads201 CreatedRequires API key

Get a presigned URL to upload a local file.

Free — credits are only charged when you create a job, not for uploading. Skip this entirely if your input is already reachable at a public URL.

curl --request POST \
  --url "https://transcode.pro/api/v1/uploads" \
  --header "Authorization: Bearer dsk_live_your_key_here" \
  --header "Content-Type: application/json" \
  --data '{"filename":"video.mp4","contentType":"video/mp4","sizeBytes":887988}'

Example response201 Createdapplication/json

{
  "mode": "single",
  "key": "uploads/...",
  "input": "https://...",
  "url": "https://...presigned..."
}

Upload the file bytes with PUT to the returned presigned url, then pass the returned input to a job.

POST/api/v1/jobs201 CreatedRequires API key

Create a job. Provide either preset (+ options) or toolId — never both, never raw filters.

curl --request POST \
  --url "https://transcode.pro/api/v1/jobs" \
  --header "Authorization: Bearer dsk_live_your_key_here" \
  --header "Content-Type: application/json" \
  --data '{"input":"https://example.com/video.mp4","preset":"transcode","options":{"width":1280,"crf":23},"output":{"filename":"out.mp4"}}'

Example response201 Createdapplication/json

{
  "id": "d7291197-0050-4cdb-a731-ebbc656ca765",
  "status": "PROCESSING",
  "creditsCharged": 13,
  "balanceAfter": 87
}

Returns 402immediately if your balance can't cover the job's cost — nothing is charged or queued in that case. If the job already finished by the time we respond (most presets do), this response also includes outputUrl (or error) directly — check status before falling back to polling GET /api/v1/jobs/:id. Pass "wait": <seconds, max 25> in the body to have us block and retry internally instead — you only get a response once the job is done (or the wait runs out).

GET/api/v1/jobs/:id200 OKRequires API key

Fetch a job's status and result.

Add ?wait=<seconds, max 25> to block on this specific job instead of polling it yourself.

curl --request GET \
  --url "https://transcode.pro/api/v1/jobs/d7291197-0050-4cdb-a731-ebbc656ca765" \
  --header "Authorization: Bearer dsk_live_your_key_here"

Example response200 OKapplication/json

{
  "id": "...",
  "status": "COMPLETED",       // QUEUED | PROCESSING | COMPLETED | FAILED | CANCELLED
  "progress": 100,
  "outputUrl": "https://...",
  "usage": { "creditsCharged": 10 }  // present once status is terminal
}

frame-sample jobs return a ZIP of individual numbered frame images as outputUrl, plus a frames: [{ "index": 1, "timeSec": 0 }, ...]manifest of each frame's timestamp.

GET/api/v1/jobs200 OKRequires API key

List jobs created by this key.

curl --request GET \
  --url "https://transcode.pro/api/v1/jobs" \
  --header "Authorization: Bearer dsk_live_your_key_here"

Example response200 OKapplication/json

{ "jobs": [ { "id": "...", "status": "COMPLETED", ... } ] }

Presets

The fixed set of operations available to every account. Pass any of these as optionsin a preset job — anything not listed isn't configurable.

probe30 base credits

Reads metadata only — no options, no output file.

Create a probe job:

curl --request POST \
  --url "https://transcode.pro/api/v1/jobs" \
  --header "Authorization: Bearer dsk_live_your_key_here" \
  --header "Content-Type: application/json" \
  --data '{"input":"https://example.com/video.mp4","preset":"probe"}'

Poll GET /api/v1/jobs/:id — once COMPLETED, the source's metadata is in the usage/probe fields; there's no downloadable output for this preset.

thumbnail30 base credits

Extracts a single frame as an image.

Option	Type	Details
timeSec	number	default 1 · 0–∞ — Timestamp to capture, in seconds.
width	integer	16–7680 — Output width in pixels (height scales automatically).
format	string	default jpg · jpg / png / webp

Create a thumbnail job:

curl --request POST \
  --url "https://transcode.pro/api/v1/jobs" \
  --header "Authorization: Bearer dsk_live_your_key_here" \
  --header "Content-Type: application/json" \
  --data '{"input":"https://example.com/video.mp4","preset":"thumbnail","options":{"timeSec":5,"width":640,"format":"jpg"}}'