Ga naar inhoud

Platformoverzicht

De OmniDoc API ondersteunt bestands- en contentworkflows binnen één account. Een aanroeper maakt resources aan met een API-sleutel en gebruikt vervolgens de stabiele ID’s die als reactie worden teruggegeven om deze op te vragen, samen te voegen, te verwerken of te downloaden.

MiddelDoel
Document / BestandBronbestanden en bestandsbibliotheekvermeldingen die eigendom zijn van het account
Taak / BewerkingAsynchrone vertaling, documentverwerking of audio- en videoprocessen
ArtifactResultaten die een taak oplevert voor voorbeeldweergave of download
KredietoperatieHet overzicht van wat er voor één factureerbare handeling in rekening is gebracht en vergoed

Elke bron wordt gecontroleerd aan de hand van het bijbehorende account. Klanten hoeven alleen openbare ID’s te bewaren en mogen geen implementatiedetails afleiden uit ID’s, bestandsnamen of downloadadressen.

  1. Maak een invoerbron aan of kies er een.
  2. Zorg ervoor dat het account over credits beschikt: het saldo wordt vóór de start van de taak gecontroleerd tegen een drempelwaarde, en het werkelijke gebruik wordt in rekening gebracht zodra de taak is voltooid.
  3. Maak de taak aan met een Idempotency-Key.
  4. Controleer de taakstatus; bestandstranslatietaken kunnen ook SSE of webhooks gebruiken.
  5. Lees de resultaten en het creditrecord voor deze taak.

Externe integraties gebruiken altijd API-sleutels, met dezelfde machtigingen als het account dat de sleutel heeft aangemaakt. Zie authenticatie .