Developer API

Programmatic access to Converty server-side conversions.

The v1 API uses the same conversion pipeline as the web app. You need an API key issued for your project.

Authentication

Send your API key on every request:

Authorization: Bearer YOUR_API_KEY
# or
X-API-Key: YOUR_API_KEY

Endpoints

Base URL: https://api.example.com

GET /v1 — API metadata (no key required)
POST /v1/convert/document — PDF, Word, Excel, …
POST /v1/convert/audio — audio · video · image · archive · ebook · 3d
GET /progress/:jobId — Server-Sent Events stream
GET /download/:jobId?token=… — Signed download
POST /import/url — Fetch a remote file (JSON body { "url": "…" })

Categories: document · audio · video · image · archive · ebook · 3d

Typical flow

POST multipart form to /v1/convert/{category} with file, from, to, and options JSON.
Receive { jobId, estimatedSeconds }.
Subscribe to GET /progress/{jobId} (SSE) for live status.
Download from the signed URL in the complete event.

curl -X POST "https://api.example.com/v1/convert/document" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@document.pdf" \
  -F "from=pdf" \
  -F "to=docx" \
  -F 'options={}'

Limits

Standard rate limits apply per IP. Files must match supported format pairs. See the converter registry for valid from/to values.

Need higher limits or a dedicated key? Contact us.