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ů.
Model zdroje
Section titled “Model zdroje”| Zdroj | Účel |
|---|---|
| Dokument / Soubor | Zdrojové soubory a položky knihovny souborů vlastněné účtem |
| Zadání / Operace | Asynchronní překlad, zpracování dokumentů nebo práce s audiem a videem |
| Artifact | Výsledky, které práce poskytuje pro náhled nebo stažení |
| Kreditní operace | Zá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í.
Běžný tok hovoru
Section titled “Běžný tok hovoru”- Vytvořte nebo vyberte vstupní zdroj.
- 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í.
- Vytvořte úlohu s
Idempotency-Key. - Zkontrolujte stav úlohy; při překladu souborů lze také použít SSE nebo webhooks.
- Přečtěte si výsledky a záznam o účtu za tuto práci.
Identita
Section titled “Identita”Externí integrace vždy používají API klíče se stejnými oprávněními jako účet, který klíč vytvořil. Viz autentizace .
Rychlý start → Nahrajte soubor, vytvořte úlohu, zkontrolujte její stav a stáhněte výsledky.