Entwickler-API

Programmatischer Zugriff auf Converty-Serverkonvertierungen.

Die v1-API nutzt dieselbe Konvertierungspipeline wie die Web-App. Sie benötigen einen API-Schlüssel für Ihr Projekt.

Authentifizierung

Senden Sie Ihren API-Schlüssel bei jeder Anfrage:

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

Endpunkte

Basis-URL: https://api.example.com

GET /v1 — API-Metadaten (kein Schlüssel erforderlich)
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=… — Signierter Download
POST /import/url — Remote-Datei abrufen (JSON-Body { "url": "…" })

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

Typischer Ablauf

POST-Multipart-Formular an /v1/convert/{category} mit file, from, to und options JSON.
Erhalten Sie { jobId, estimatedSeconds }.
Abonnieren Sie GET /progress/{jobId} (SSE) für Live-Status.
Download über die signierte URL im complete-Ereignis.

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={}'

Beschränkungen

Standard-Rate-Limits gelten pro IP. Dateien müssen unterstützte Formatpaare entsprechen. Siehe Converter-Registry für gültige from/to-Werte.

Höhere Limits oder dedizierten Schlüssel benötigt? Kontakt.