Zum Hauptinhalt springen
open-toolsopen-tools

API

open-tools API

Programmatischer Zugriff auf alle unsere Werkzeuge. Verwenden Sie es, um Massen-PDF- oder Bildverarbeitungsaufgaben in Ihre eigenen Pipelines zu integrieren.

Schnellstart

  1. Konto erstellen wenn Sie noch keins haben.
  2. API-Schlüssel erstellen aus Konto → API-Schlüssel. Der vollständige Token wird einmalangezeigt; kopieren Sie ihn jetzt.
  3. Übergeben Sie den Token als Authorization: Bearer otk_… bei jeder Anfrage.

Referenz

Die vollständige OpenAPI-Spezifikation — jeder Endpunkt, jeder Parameter, jede Antwortform — wird automatisch aus der FastAPI-App generiert und als JSON bereitgestellt. Swagger UI und ReDoc rendern sie beide.

Die interaktive API-Referenz öffnen →

Bevorzugen Sie die Rohspezifikation oder eine Live-Konsole? Das maschinenlesbare OpenAPI-JSON und die Swagger-/ReDoc-Explorer stehen angemeldeten Konten zur Verfügung:

Beispiel — PDF aufteilen

Datei hochladen und auf das Ergebnis warten:

# 1. Upload and create the job
curl -X POST 'https://api.open-tools.app/api/upload' \
  -H 'Authorization: Bearer otk_YOUR_KEY' \
  -F 'file=@input.pdf' \
  -F 'job_type=pdf-split' \
  -F 'parameters={"pages": "1-3"}'
# → {"job_id": "abc123", "status": "queued", "ws_token": "..."}

# 2. Poll job status (or subscribe via WebSocket /ws/<job_id>?token=<ws_token>)
curl 'https://api.open-tools.app/api/jobs/abc123' \
  -H 'Authorization: Bearer otk_YOUR_KEY'
# → {"status": "completed", "output_file_url": "https://api.open-tools.app/api/download/users/42/..."}

# 3. Download the result
curl -o output.pdf 'https://api.open-tools.app/api/download/users/42/<uuid>.pdf' \
  -H 'Authorization: Bearer otk_YOUR_KEY'

Fehlercodes

Alle Fehler teilen dieselbe Umschlagsform:

{
  "detail": {
    "error": {
      "code": "INVALID_FILE_TYPE",
      "message": "image-resize requires PNG, JPG, or WEBP.",
      "details": { "expected_extensions": [".png", ".jpg", ".webp"] }
    }
  }
}
HTTPCodeBedeutung
400INVALID_FILE_TYPEDateiendung nicht in der Zulassungsliste dieses Jobs.
400INVALID_FILE_SIGNATUREMagic-Bytes stimmen nicht mit der Erweiterung überein.
400INVALID_PARAMETERSDas parameters JSON hat die Schemavalidierung nicht bestanden.
401AUTH_REQUIREDKein Sitzungs-Cookie oder API-Schlüssel in der Anfrage.
403REAUTH_REQUIREDSensible Aktion; Sitzung älter als 15 Min.
413FILE_TOO_LARGEUpload überschreitet die 50-MB-Grenze.
429RATE_LIMITEDStufenfenster überschritten. Siehe Retry-After.
500INTERNAL_ERRORFehler. Bitte den Header request_id beifügen.

Ratenlimits und Nutzung

Jedes Konto erhält Kontingente pro Minute, Stunde, Tag und Monat. Die aktuelle Nutzung ist sichtbar unter Ihrem Konto-Dashboard. Einen 429 bekommen? Warten Sie, bis das Fenster weitergleitet; die Antwort enthältRetry-After Sekunden.