Záhlaví požadavku
Použijte X-API-Key: sk_… nebo Authorization: Bearer sk_…, vždy jeden z nich na každou žádost. Odešlete Content-Type: application/json s těly JSON.
Base URL https://omnidoc.top/api/v1 · HTTPS · JSON · Autentizace pomocí API klíče · překlad souborů probíhá jako asynchronní úlohy
Tato stránka popisuje cloudové rozhraní API HTTP.
Před nahráním souborů se ujistěte, že vaše klíč a síť fungují. Kontrola zůstatku nevyužívá žádné kredity a nevytváří žádnou překladovou zakázku.
Získejte API klíč
Přihlaste se do API konzole a vytvořte klíč začínající na sk_. Pro každou aplikaci použijte samostatný klíč a nastavte mu rozpočet.
Klíč slouží pro účet, který jej vytvořil. Uchovávejte jej na serveru a čtěte ho z proměnné prostředí; nikdy jej neuvádějte do zdrojového kódu webové stránky ani do veřejného repozitáře.
Zkontrolujte zůstatek
Nastavte proměnnou prostředí OMNIDOC_API_KEY a poté spusťte libovolný z níže uvedených příkladů. Úspěch vrátí JSON; 401 znamená, že klíč má problém a je třeba jej zkontrolovat. V žádném případě nezobrazujte celý klíč v tiketech, snímcích obrazovky ani protokolech.
export OMNIDOC_API_KEY="sk_your_key"curl --fail-with-body --silent --show-error \ 'https://omnidoc.top/api/v1/billing/credits/balance' \ -H "X-API-Key: $OMNIDOC_API_KEY"import osimport requests
response = requests.get( "https://omnidoc.top/api/v1/billing/credits/balance", headers={"X-API-Key": os.environ["OMNIDOC_API_KEY"]}, timeout=30,)response.raise_for_status()print(response.json())// Node.js 20+, save as balance.mjsconst apiKey = process.env.OMNIDOC_API_KEY;if (!apiKey) throw new Error('Set OMNIDOC_API_KEY');const response = await fetch('https://omnidoc.top/api/v1/billing/credits/balance', { headers: { 'X-API-Key': apiKey }, signal: AbortSignal.timeout(30_000),});if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);console.log(await response.json());Úspěšné nahrání znamená pouze, že soubor byl uložen. Po vytvoření úlohy počkejte, dokud nedosáhne konečného stavu, a teprve poté zobrazte a stáhněte její výsledky.
| Krok | Metoda a cesta | Co zachovat |
|---|---|---|
| Požádejte o nahrání | POST /upload/presign | upload_url, upload_headers, finalize_token |
| Odešlete soubor | PUT na vrácené upload_url | Odpověď o úspěšném provedení; tato žádost neobsahuje API klíč. |
| Potvrďte nahrání | POST /upload/finalize | document.id |
| Vytvořte překlad | POST /jobs | Zadání id |
| Zkontrolujte stav | GET /jobs/{job_id} | completed nebo failed |
| Vypsat výsledky | GET /artifacts?job_id={job_id} | ID artefaktů a formáty |
| Stáhnout výsledek | GET /artifacts/{artifact_id}/download | Souborové bajty a název odpovědního souboru |
For the direct upload, send the upload_headers from the server exactly as returned, and never send X-API-Key to the storage address. If the upload address expires or the transfer fails, request a new one. Details: upload protocol, quick start, complete Node.js workflow and translation request fields.
Každý záznam uvádí cesty, pole požadavků a příklady. Stav služby vašeho účtu a limity vašeho klíče se vztahují na všechny z nich.
Klíč API identifikuje účet. Není to veřejné heslo pro stahování souboru.
Záhlaví požadavku
Použijte X-API-Key: sk_… nebo Authorization: Bearer sk_…, vždy jeden z nich na každou žádost. Odešlete Content-Type: application/json s těly JSON.
Co může klíč dosáhnout
Klíč má přístup pouze k prostředkům, které může jeho účet využívat; platí stále stav služby, rozpočet klíče a povolená nastavení překladu. Změny účtu a vytváření, otáčení nebo zrušení klíčů probíhají v konzoli.
Viz autentizace, rozpočty a rotace a služby a oprávnění .
Časový limit neznamená, že úloha nebyla vytvořena. Rozlišujte opakovatelné chyby od požadavků, které je třeba opravit, aby nedošlo k dvojímu odeslání nebo zpracování žádných dat.
Idempotency-Key; při opakovaném pokusu o stejnou operaci použijte původní klíč a identické tělo požadavku. Operace dokumentů, médiajoby a tvorba hlasu vyžadují klíč; pro ostatní koncové body vytvoření viz jejich referenční stránky.| Stav | Nejprve zkontrolujte | Co dělat |
|---|---|---|
401 / 403 | Klíč, oprávnění, vlastnictví zdrojů | Opravte přihlašovací údaje nebo oprávnění; nezkoušejte znovu bezhlavě. |
402 | Dostupné kredity | Přidejte kredit a pak odešlete znovu |
409 | Klíč a tělo idempotence, stav zdroje | Před zahájením nové operace dotazujte původní operaci. |
422 | Chyby v polích v odpovědi | Opravte parametry nebo soubor |
429 | Business code a Retry-After | Omezení rychlosti a fronty lze vyčkat; před zvýšením limitu klíče je nutné nejprve doplnit rozpočet klíče. |
5xx | Dočasná chyba služby | Omezené exponenciální zpoždění; zachovejte idempotentní klíč pro požadavky na vytvoření |
Uchovávejte záhlaví odpovědi X-Request-Id, čas požadavku a cestu pro řešení problémů; nikdy nezapisujte celý klíč. Všechny kódy chyb a příklady opakování jsou v odkazu na chyby error reference .
Žádné kredity
Nahrávání, kontrola úloh, stahování výsledků a čtení záznamů o zůstatcích a vypořádání nevyužívají žádné kredity; totéž platí pro slovníky, projekty, štítky, vyhledávání a sdílení.
Zúčtováno podle použití
Překlad souborů, nástroje pro práci s dokumenty, okamžitý překlad a služby pro audio a video jsou zpoplatněny podle skutečného využití; vytvoření úlohy není konečná cena.
Před zahájením úlohy je kontrolován pouze prahový limit zůstatku; po jejím dokončení je účtováno skutečné využití. Pokud je zůstatek nedostatečný, rozdíl je evidován jako dluh a později přijaté kredity jsou na jeho uhrazení uplatňovány jako první. Můžete provést srovnání poplatků a refundací pro jednotlivé úlohy nebo pro každou kreditní operaci. Když je rozpočet klíče vyčerpán, můžete stále dotazovat úlohy, výsledky a záznamy pod tímto klíčem.