Zum Inhalt springen

Plattformübersicht

Die OmniDoc API unterstützt Datei- und Inhaltsworkflows innerhalb eines einzigen Kontos. Ein Aufrufer erstellt Ressourcen mit einem API-Schlüssel und verwendet anschließend die zurückgegebenen stabilen IDs, um diese abzufragen, zu kombinieren, zu verarbeiten oder herunterzuladen.

RessourceZweck
Dokument / DateiQuelldateien und Dateibibliothekseinträge, die dem Konto gehören
Job / OperationAsynchrone Übersetzungs-, Dokumentenverarbeitungs- oder Audio-/Video-Jobs
ArtifactErgebnisse, die ein Auftrag für die Vorschau oder den Download liefert
KreditoperationDie Aufzeichnung darüber, welche abrechenbare Maßnahme abgerechnet und erstattet wurde

Jede Ressource wird mit dem zugehörigen Konto abgeglichen. Clients müssen lediglich öffentliche IDs beibehalten und dürfen keine Implementierungsdetails aus IDs, Dateinamen oder Download-Adressen ableiten.

  1. Erstellen oder wählen Sie eine Eingaberessource.
  2. Stellen Sie sicher, dass das Konto über Guthaben verfügt: Der Kontostand wird vor Beginn des Jobs mit einem Schwellenwert verglichen, und die tatsächliche Nutzung wird nach Abschluss abgerechnet.
  3. Erstellen Sie den Job mit einem Idempotency-Key.
  4. Überprüfen Sie den Auftragsstatus; Dateiübersetzungsjobs können auch SSE oder Webhooks verwenden.
  5. Lesen Sie die Ergebnisse und den Kreditprotokoll für diesen Auftrag.

Externe Integrationen verwenden stets API-Schlüssel mit denselben Berechtigungen wie das Konto, das den Schlüssel erstellt hat. Siehe Authentifizierung .