Přeskočit na obsah

Přehled platformy

API OmniDoc spravuje soubory a pracovní postupy s obsahem v rámci jednoho účtu. Volající vytváří zdroje pomocí API klíče a následně používá zpět získané stabilní ID k dotazování, kombinaci, zpracování nebo stahování těchto zdrojů.

ZdrojÚčel
Dokument / SouborZdrojové soubory a položky knihovny souborů vlastněné účtem
Zadání / OperaceAsynchronní překlad, zpracování dokumentů nebo práce s audiem a videem
ArtifactVýsledky, které práce poskytuje pro náhled nebo stažení
Kreditní operaceZáznam o tom, jaká účtovatelná činnost byla zpoplatněna a proplacena

Každý zdroj je ověřován vzhledem k příslušnému účtu. Klienti musí uchovávat pouze veřejné ID a nemají vyvozovat implementační podrobnosti z ID, názvů souborů nebo adres ke stažení.

  1. Vytvořte nebo vyberte vstupní zdroj.
  2. Ujistěte se, že účet má kredity: zůstatek je před spuštěním úlohy porovnán s hranicí a skutečné využití je účtováno po jejím dokončení.
  3. Vytvořte úlohu s Idempotency-Key.
  4. Zkontrolujte stav úlohy; při překladu souborů lze také použít SSE nebo webhooks.
  5. Přečtěte si výsledky a záznam o účtu za tuto práci.

Externí integrace vždy používají API klíče se stejnými oprávněními jako účet, který klíč vytvořil. Viz autentizace .