Сұраным тақырыбы
X-API-Key: sk_… немесе Authorization: Bearer sk_… қолданыңыз, сұраныс бойынша екеуінің біреуін. JSON денелерімен бірге Content-Type: application/json жіберіңіз.
Base URL https://omnidoc.top/api/v1 · HTTPS · JSON · API кілті аутентификациясы · файлды аудару асинхронды тапсырмалар ретінде орындалады
Бұл сайт HTTP бұлтты API-ді сипаттайды.
Файлдарды жүктеуден бұрын кілтіңіз бен желінің жұмыс істейтініне көз жеткізіңіз. Баланс тексеруі ешқандай несие жұмсамайды және аударма тапсырмасын туғызбайды.
API кілтін алыңыз
API консоліне кіріңіз және sk_ басталатын кілт жасаңыз. Әрбір қосымша үшін жеке кілт пайдаланып, оған бюджет белгілеңіз.
Кілт оны жасаған есептік жазба үшін жұмыс істейді. Оны серверде сақтаңыз және орташа айнымалыдан оқыңыз; оны ешқашан веб-бет дереккөзіне немесе жария репозиторийге енгізбеңіз.
Балансты тексеру
OMNIDOC_API_KEY ортақ айнымалысын орнатыңыз, содан кейін төмендегі мысалдардың кез келгенін іске қосыңыз. Сәттілік жағдайда JSON қайтарылады; 401 — кілтте мәселе бар дегенді білдіреді және оны тексеру қажет. Тикеттерде, скриншоттарда немесе журналдарда толық кілтті ешқашан көрсетпеңіз.
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());Сәтті жүктеу тек файлдың сақталғанын білдіреді. Жұмыс жасағаннан кейін, оның соңғы күйге жетуін күтіп, содан кейін нәтижелерін тізімдеңіз және жүктеп алыңыз.
| Қадам | Әдіс және жол | Нені сақтау керек |
|---|---|---|
| Жүктеуді сұрау | POST /upload/presign | upload_url, upload_headers, finalize_token |
| Файлды жіберіңіз | PUT қайтарылған upload_url-ге | Сәтті жауап; бұл сұрақта API кілті жоқ |
| Жүктеуді растаңыз | POST /upload/finalize | document.id |
| Аударма жасаңыз | POST /jobs | Жұмыс id |
| Мәртебені тексеру | GET /jobs/{job_id} | completed немесе failed |
| Нәтижелерді тізімдеңіз | GET /artifacts?job_id={job_id} | Артефакт идентификаторлары мен форматтары |
| Нәтижені жүктеу | GET /artifacts/{artifact_id}/download | Файл байттары және жауап файлының атауы |
Тікелей жүктеу үшін серверден upload_headers дәл осылай қайтарылған күйінде жіберіңіз, ал сақтау мекенжайына ешқашан X-API-Key жібермеңіз. Егер жүктеу мекенжайының мерзімі өтсе немесе тасымалдау сәтсіз аяқталса, жаңасын сұраңыз. Егжей-тегжей: жүктеу хаттамасы , жылдам бастау , толық Node.js жұмыс процесі және аударма сұранысы өрістері .
Әрбір жазба жолдарды, сұраным өрістерін және мысалдарды көрсетеді. Сіздің тіркелгіңіздің қызмет көрсету мәртебесі мен кілтіңіздің шектеулері олардың барлығына қолданылады.
API кілті аккаунтты сәйкестендіреді. Бұл файлды жүктеп алуға арналған жария пароль емес.
Сұраным тақырыбы
X-API-Key: sk_… немесе Authorization: Bearer sk_… қолданыңыз, сұраныс бойынша екеуінің біреуін. JSON денелерімен бірге Content-Type: application/json жіберіңіз.
Кілт қол жеткізе алатын нәрсе
Кілт тек оның есептік жазбасы пайдалана алатын ресурстарға ғана жетеді; қызмет мәртебесі, кілттің бюджеті және рұқсат етілген аудару параметрлері әлі де қолданылады. Есептік жазбаға өзгерістер енгізу, кілттерді жасау, айналдыру немесе жою консольде жүзеге асырылады.
Қараңыз аутентификация, бюджеттер және ротация және қызметтер мен рұқсаттар .
Уақытша үзіліс жұмыстың жасалмағанын білдірмейді. Ештеңе екі рет жіберілмеуі немесе өңделмеуі үшін, түзетуді қажет ететін сұранымдардан қайта тырысуға болатын қателіктерді ажыратыңыз.
Idempotency-Key генерациялаңыз; сол операцияны қайта жасағанда, түпнұсқа кілт пен дәл сондай сұраным денесін қайта пайдаланыңыз. Кілтті құжат операциялары, медиа жұмыстары және дауысты жасау үшін қажет; басқа жасау эндпоинттары үшін олардың анықтамалық беттерін қараңыз.| Мәртебе | Алдымен тексеріңіз | Не істеу керек |
|---|---|---|
401 / 403 | Кілт, рұқсаттар, ресурстар иелігі | Кредиттік деректерді немесе рұқсаттарды түзетіңіз; көрсетілген әрекеттерді қайталаудан аулақ болыңыз. |
402 | Қол жетімді несиелер | Толықтырыңыз, содан кейін қайтадан жіберіңіз |
409 | Идемпотенттік кілті мен денесі, ресурстың күйі | Жаңа операцияны бастамас бұрын алғашқы операцияны сұраңыз |
422 | Жауаптағы өріс қателері | Параметрлерді немесе файлды түзетіңіз |
429 | Бизнес code және Retry-After | Тариф пен кезектік шектеулерді күтуге болады; бір рет пайдаланылған кілт бюджетін алдымен ұлғайту керек |
5xx | Уақытша қызмет қатесі | Шектеулі экспоненциалды кері санау; жасау сұраныстары үшін идемпотенттік кілтті сақтаңыз |
Ақаулықтарды шешу үшін X-Request-Id жауап тағанын, сұраным уақытын және жолды сақтаңыз; толық кілтті ешқашан жазбаңыз. Барлық қате кодтары мен қайта тырысу мысалдары қате анықтамасы бөлімінде келтірілген.
Кредиттер жоқ
Жүктеу, тапсырмаларды тексеру, нәтижелерді жүктеу және баланс пен есеп айырысу жазбаларын оқу несие жұмсамайды; сондай-ақ глоссарийлер, жобалар, тегтер, іздеу және бөлісу де несие жұмсамайды.
Пайдалану бойынша есептеледі
Файлды аудару, құжаттарға арналған құралдар, жедел аударма және аудио мен бейне сервистерінің бағасы нақты пайдалану көлеміне сәйкес белгіленеді; тапсырманы жасау тек соңғы шығын емес.
Жұмыс басталғанға дейін тек теңгерім шегі тексеріледі; ал ол аяқталғаннан кейін нақты пайдалану үшін төлем жасалады. Егер теңгерім жеткіліксіз болса, айырмашылық қарыз ретінде есепке алынады, ал кейінірек келген несиелер оны бірінші кезекте өтейді. Сіз төлемдер мен қайтарымдарды жұмыс немесе несие операциясы бойынша теңестіре аласыз. Кілттің бюджеті таусылған жағдайда да сіз сол кілт бойынша жұмыстарды, нәтижелерді және жазбаларды сұрай аласыз.