Zaglavlje zahtjeva
Koristite X-API-Key: sk_… ili Authorization: Bearer sk_…, jedan od njih dvoje po zahtjevu. Pošaljite Content-Type: application/json s tijelima JSON.
Base URL https://omnidoc.top/api/v1 · HTTPS · JSON · Autentifikacija pomoću ključa API-a · izvođenje prevoda datoteka kao asinhronih zadataka
Ova stranica opisuje API oblaka HTTP.
Provjerite da vaš ključ i mreža funkcioniraju prije nego što prenesete datoteke. Provjera stanja na računu ne oduzima kredite niti stvara zadatak za prijevod.
Za dobivanje ključa API-a
Prijavite se na API konzolu i kreirajte ključ koji počinje s sk_. Koristite zaseban ključ za svaku aplikaciju i odredite mu budžet.
Ključ vrijedi za račun koji ga je kreirao. Čuvajte ga na serveru i čitajte ga iz promjenljive okoline; nikada ga ne stavljajte u izvor web stranice ili javni repozitorij.
Provjerite stanje
Postavite okružnu promjenljivu OMNIDOC_API_KEY, a zatim pokrenite bilo koji od dolje navedenih primjera. Uspjeh vraća JSON; 401 znači da ključ ima problem i treba ga provjeriti. Nikada ne prikazujte cijeli ključ u tiketima, snimkama zaslona ili logovima.
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());Uspješno učitavanje samo znači da je datoteka pohranjena. Nakon što kreirate zadatka, pričekajte da dostigne konačno stanje, a zatim navedite i preuzmite njegove rezultate.
| Korak | Metoda i putanja | Što zadržati |
|---|---|---|
| Zatražite učitavanje | POST /upload/presign | upload_url, upload_headers, finalize_token |
| Pošalji datoteku | PUT do vraćenog upload_url | Odgovor o uspješnom izvršenju; ovaj zahtjev ne sadrži API ključ. |
| Potvrdite učitavanje | POST /upload/finalize | document.id |
| Stvorite prijevod | POST /jobs | Posao id |
| Provjerite status | GET /jobs/{job_id} | completed ili failed |
| Popis rezultata | GET /artifacts?job_id={job_id} | ID-ovi i formati artefakata |
| Preuzmite rezultat | GET /artifacts/{artifact_id}/download | Bajtovi datoteke i naziv datoteke odgovora |
Za izravno učitavanje pošaljite upload_headers s poslužitelja točno onako kako je vraćeno i nikada ne šaljite X-API-Key na adresu za pohranu. Ako adresa za učitavanje istekne ili prijenos ne uspije, zatražite novu. Detalji: protokol za učitavanje, brzi početak, cijeli tijek rada Node.js i polja za zahtjev za prijevod.
Svaki unos navodi putanje, polja zahtjeva i primjere. Status usluge vašeg računa i ograničenja vašeg ključa primjenjuju se na sve njih.
API ključ identificira račun. To nije javna lozinka za preuzimanje datoteke.
Zaglavlje zahtjeva
Koristite X-API-Key: sk_… ili Authorization: Bearer sk_…, jedan od njih dvoje po zahtjevu. Pošaljite Content-Type: application/json s tijelima JSON.
Što ključ može dosegnuti
Ključ pristupa samo resursima koje njegov račun može koristiti; status usluge, budžet ključa i dopuštena postavka prevoda i dalje vrijede. Promjene računa te kreiranje, rotacija ili otkazivanje ključeva obavljaju se u konzoli.
Vidjeti autentifikaciju, proračune i rotaciju i servise i dozvole .
Vrijeme izvršavanja ne znači da zadatak nije kreiran. Razlikujte pogreške koje se mogu ponoviti od zahtjeva koji trebaju popravak, kako ništa ne bi bilo predano ili obrađeno dva puta.
Idempotency-Key za svaku novu operaciju kreiranja; kada ponovno pokušate istu operaciju, ponovno koristite izvorni ključ i potpuno isto tijelo zahtjeva. Operacije dokumenta, zadaci za medije i kreiranje glasa zahtijevaju ključ; za ostale krajnje točke kreiranja pogledajte njihove referentne stranice.| Status | Prvo provjerite | Što učiniti |
|---|---|---|
401 / 403 | Ključ, dozvole, vlasništvo nad resursima | Popravite vjerodajnice ili dozvole; nemojte ponovno pokušavati bez razmišljanja |
402 | Dostupni krediti | Napunite račun, a zatim ponovno pošaljite |
409 | Ključ i tijelo idempotencije, stanje resursa | Pozovite izvornu operaciju prije pokretanja nove |
422 | Pogreške polja u odgovoru | Popravite parametre ili datoteku |
429 | Poslovanje code i Retry-After | Ograničenja brzine i reda čekanja mogu se isčekati; potrebno je prvo povećati potrošeni budžet ključeva. |
5xx | Privremena greška usluge | Ograničeno eksponencijalno odgađanje; zadržite ključ idempotencije za zahtjeve za kreiranje |
Zadržite zaglavlje odgovora X-Request-Id, vrijeme zahtjeva i putanjicu za rješavanje problema; nikada ne bilježite cijelu ključnu oznaku. Svi kodovi grešaka i primjeri ponovnog pokušaja nalaze se u referenci greška .
Bez kredita
Prijavlivanje, provjera zadataka, preuzimanje rezultata te čitanje stanja i evidencije o poravnanju ne troše kredite; isto vrijedi i za rječnike, projekte, oznake, pretraživanje i dijeljenje.
Fakturiran prema korištenju
Prijenos datoteka, alati za dokumente, trenutni prijevod te usluge audio i video sadržaja obračunavaju se prema stvarnoj potrošnji; kreiranje zadatka nije konačna naplata.
Prije početka zadatka provjerava se samo prag stanja; nakon njegova završetka obračunava se stvarna potrošnja. Ako stanje nije dovoljno, razlika se evidentira kao dug, a krediti koji kasnije pristignu prvo ga podmire. Možete izvršiti usklađivanje naplata i povrata za pojedini zadatak ili za pojedinu kreditnu operaciju. Kada se potroši budžet ključa, i dalje možete pretraživati zadatke, rezultate i zapise povezane s tim ključem.