Záhlavie požiadavky
Použite X-API-Key: sk_… alebo Authorization: Bearer sk_…, jeden z nich na každú žiadosť. Pošlite Content-Type: application/json s telami JSON.
Base URL https://omnidoc.top/api/v1 · HTTPS · JSON · Autentifikácia pomocou kľúča API · prevod súborov prebieha ako asynchrónne úlohy
Táto stránka popisuje cloudové rozhranie HTTP.
Pred nahrávaním súborov sa uistite, že váš kľúč a sieť fungujú. Kontrola zostatku nestojí žiadne kredity a nevytvára žiadnu prekladovú úlohu.
Získajte kľúč API
Prihláste sa do API konzoly a vytvorte kľúč začínajúci na sk_. Používajte samostatný kľúč pre každú aplikáciu a priraďte mu rozpočet.
Kľúč slúži pre účet, ktorý ho vytvoril. Uchovávajte ho na serveri a čítajte ho z premenného prostredia; nikdy ho neuvádzajte do zdrojového kódu webovej stránky ani do verejného repozitára.
Skontrolujte zostatok
Nastavte premennú prostredia OMNIDOC_API_KEY a potom spustite niektorý z nasledujúcich príkladov. Úspech vráti JSON; 401 znamená, že kľúč má problém a je potrebné ho skontrolovať. Nikdy nezobrazujte celý kľúč v tiketoch, snímkach obrazovky ani protokoloch.
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());Úspešné nahratie znamená iba, že súbor bol uložený. Po vytvorení úlohy počkajte, kým nedosiahne konečný stav, a potom si zoberte zoznam jej výsledkov a stiahnite ich.
| Krok | Metóda a cesta | Čo zachovať |
|---|---|---|
| Požiadajte o nahratie | POST /upload/presign | upload_url, upload_headers, finalize_token |
| Odošlite súbor | PUT na vrátené upload_url | Odpoveď o úspešnom vykonaní; táto požiadavka neobsahuje žiadny API kľúč. |
| Potvrďte nahrávanie | POST /upload/finalize | document.id |
| Vytvorte preklad | POST /jobs | Zamestnanie id |
| Skontrolujte stav | GET /jobs/{job_id} | completed alebo failed |
| Vypíšte výsledky | GET /artifacts?job_id={job_id} | ID artefaktov a formáty |
| Stiahnuť výsledok | GET /artifacts/{artifact_id}/download | Súbory bajtov a názov súboru odpovede |
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ádza cesty, požiadavkové polia a príklady. Stav služby vášho účtu a limity vášho kľúča sa vzťahujú na všetky z nich.
Kľúč API identifikuje účet. Nie je to verejný heslo na stiahnutie súboru.
Záhlavie požiadavky
Použite X-API-Key: sk_… alebo Authorization: Bearer sk_…, jeden z nich na každú žiadosť. Pošlite Content-Type: application/json s telami JSON.
Čo dokáže kľúč dosiahnuť
Kľúč má prístup iba k prostriedkom, ktoré môže používať jeho účet; platia stále nastavenia služby, rozpočet kľúča a povolené nastavenia prekladu. Zmeny v účte a vytváranie, rotovanie alebo zrušenie kľúčov sa vykonávajú v konzole.
Pozri autentifikácia, rozpočty a rotácia a služby a oprávnenia .
Časový limit neznamená, že úloha nebola vytvorená. Rozlišujte medzi chybami, ktoré je možné opakovať, a požiadavkami, ktoré je potrebné opraviť, aby sa nič neodoslalo alebo nespracovalo dvakrát.
Idempotency-Key; pri opakovaní rovnakej operácie použite pôvodný kľúč a presne rovnaké telo požiadavky. Operácie dokumentov, médií a tvorby hlasu vyžadujú tento kľúč; pre ostatné koncové body vytvárania pozrite ich referenčné stránky.| Stav | Najskôr skontrolujte | Čo robiť |
|---|---|---|
401 / 403 | Kľúč, povolenia, vlastníctvo zdrojov | Opravte poverenia alebo práva; neopakujte pokus bezhlavo. |
402 | Dostupné kredity | Doplňte zostatok a potom odošlite znova. |
409 | Kľúč a telo idempotencie, stav zdroja | Pred spustením novej operácie si overte pôvodnú operáciu. |
422 | Chyby v poliach v odpovedi | Opravte parametre alebo súbor |
429 | Obchodné code a Retry-After | Limitov na rýchlosť a fronty je možné počkať; predtým je potrebné zvýšiť vyčerpaný rozpočet kľúčov. |
5xx | Dočasná chyba služby | Obmedzený exponenciálny opakovaný pokus; zachovajte kľúč idempotencie pre požiadavky na vytvorenie |
Uchovajte hlavičku odpovede X-Request-Id, čas požiadavky a cestu na riešenie problémov; nikdy nezapisujte celý kľúč. Všetky kódy chýb a príklady opakovaných pokusov sú v referencii chýb . .
Žiadne kredity
Nahrávanie, kontrola úloh, sťahovanie výsledkov a čítanie zostatku a záznamov o vypočítaní nezapočítavajú žiadne kredity; rovnako tak ani glosáre, projekty, značky, vyhľadávanie a zdieľanie.
Účtované podľa použitia
Preklad súborov, nástroje na dokumenty, okamžitý preklad a služby pre audio a video sa účtujú podľa skutočného využitia; vytvorenie úlohy nie je konečná cena.
Pred spustením úlohy sa kontroluje iba prah zostatku; po jej dokončení sa účtuje skutočné využitie. Ak zostatok nestačí, rozdiel sa eviduje ako dlh a neskôr pripísané kredity ho najprv splácajú. Môžete vyrovnať poplatky a vrátenia peňazí podľa jednotlivých úloh alebo operácií s kreditmi. Keď je rozpočet kľúča vyčerpaný, stále môžete dotazovať úlohy, výsledky a záznamy pre daný kľúč.