API áttekintés
Base URL
https://omnidoc.top/api/v1Küldje el a Content-Type: application/json kéréseket a JSON segítségével. Az API-kulcs a X-API-Key fejlécbe vagy a Bearer hitelesítő adatokként kerül beillesztésre.
Szolgáltatások
Szekció neve “Szolgáltatások”| Szolgáltatás | Fő útvonalak | Cél |
|---|---|---|
| Fájl feltöltése | /upload/* | Töltsön fel és erősítse meg a dokumentumokat |
| Fájlkönyvtár | /storage/files/*, /documents/* | Listázás, olvasás és letöltés |
| Fordítás | /jobs/*, /artifacts/* | Állások létrehozása, állapot és eredmények ellenőrzése |
| Dokumentumeszközök | /document-operations/*, /file-tools/* | Konvertálás, összevonás, szétválasztás, tömörítés és még sok más |
| Azonnali fordítás | /ai/* | Rövid szöveg és batch szakasz fordítása |
| Audio és video | /media-jobs/*, /media-voices/* | Munkák és hangok |
| Glosszár | /glossaries/* | Fogalmak, import és export |
| Felhasználás és köszönetnyilvánítás | /usage/*, /billing/credits/* | Felhasználási, egyenleg- és elszámolási rekordok |
| Értesítések | /sse/*, /webhooks/* | Élő folyamat és visszahívások |
Mely szolgáltatásokat hívhatja meg, és mennyibe kerülnek: szolgáltatások és engedélyek .
Konvenciók
Szekció neve “Konvenciók”- Az erőforrásazonosítók átláthatatlan karakterláncok.
- Küldjön egy
Idempotency-Keylétrehozási kérésekkel; a műveletek, médiafeladatok és hanglétrehozás dokumentálásához szükség van rá. - Az oldalszámozási paramétereket az egyes végpontok oldalán ismertetjük.
- Kezelje a
429esetet a hibák és újrapróbálások leírása szerint. - A letöltött fájlok nevei csak megjelenítésre szolgálnak; a mentés előtt vegye ki a fájlnevet, és alkalmazza a fájlrendszer korlátait.
Kérésmegfigyelés
Szekció neve “Kérésmegfigyelés”Mentsd meg a minden válasz X-Request-Id értékét. Amikor felkeresed a támogatást, add meg ezt az értéket, a kérés időpontját és az útvonalat; soha ne küldd el a teljes API-kulcsot vagy a fájl tartalmát.