अनुरोध हेडर
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 प्रतिक्रिया हेडर, अनुरोध समय और पथ को संरक्षित रखें; पूरी कुंजी को कभी भी लॉग न करें। सभी त्रुटि कोड और पुनः प्रयास उदाहरण त्रुटि संदर्भ में दिए गए हैं।
कोई क्रेडिट नहीं
अपलोड करना, जॉब्स की जाँच करना, परिणाम डाउनलोड करना और बैलेंस तथा सेटलमेंट रिकॉर्ड पढ़ना किसी भी क्रेडिट का खर्च नहीं करते; ग्लॉसरी, प्रोजेक्ट्स, टैग्स, खोज और साझाकरण भी इसमें शामिल हैं।
उपयोग के अनुसार शुल्क लिया जाता है
फ़ाइल अनुवाद, दस्तावेज़ उपकरण, तत्काल अनुवाद और ऑडियो एवं वीडियो सेवाएँ उनकी वास्तविक उपयोग के अनुसार मूल्य निर्धारित की जाती हैं; कार्य बनाने पर अंतिम शुल्क नहीं लगाया जाता।
किसी कार्य के शुरू होने से पहले, केवल बैलेंस की थ्रेशोल्ड जाँच की जाती है; इसके समाप्त होने के बाद, वास्तविक उपयोग का शुल्क लगाया जाता है। यदि बैलेंस कम पड़ता है, तो अंतर को ऋण के रूप में दर्ज किया जाता है, और बाद में आने वाले क्रेडिट इसे पहले चुकाते हैं। आप प्रति कार्य या प्रति क्रेडिट संचालन के अनुसार शुल्क और रिफंड का मिलान कर सकते हैं। जब किसी कुंजी का बजट समाप्त हो जाता है, तब भी आप उस कुंजी के तहत कार्यों, परिणामों और रिकॉर्ड का प्रश्न पूछ सकते हैं।