विनंती हेडर
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_ पासून सुरू होणारी की तयार करा. प्रत्येक अनुप्रयोगासाठी स्वतंत्र की वापरा आणि त्यास बजेट निश्चित करा.
कीज ही त्या खात्यासाठी कार्य करते ज्याने ती तयार केली आहे. ती सर्व्हरवर ठेवा आणि एखाद्या वातावरण च biến्याबिल्टमधून वाचा; ती कधीही वेब पृष्ठाच्या स्रोतात किंवा सार्वजनिक रिपॉझिटरीमध्ये ठेवू नका.
शिल्लक तपासा
OMNIDOC_API_KEY हे पर्यावरण च biếnित्र सेट करा, त्यानंतर खालील उदाहरणांपैकी कोणतेही एक चालवा. यशस्वी असल्यास 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 | तात्पुरती सेवा त्रुटी | मर्यादित एक्सपोनेंशियल बॅकऑफ; create विनंत्यांसाठी idempotency की ठेवा |
X-Request-Id रिस्पॉन्स हेडर, विनंतीची वेळ आणि मार्ग तपासणीसाठी ठेवा; पूर्ण की कधीही लॉग करू नका. सर्व त्रुटी कोड आणि पुन्हा प्रयत्नांची उदाहरणे error reference मध्ये आहेत.
क्रेडिट नाहीत
अपलोड करणे, जॉब्स तपासणे, परिणाम डाउनलोड करणे आणि बॅलन्स आणि सेटलमेंट रेकॉर्ड्स वाचणे यांसाठी क्रेडिट लागत नाही; ग्लॉसरी, प्रोजेक्ट्स, टॅग्स, सर्च आणि शेअरिंग यांसाठीही क्रेडिट लागत नाही.
वापरानुसार आकारणी केली जाते
फाइल अनुवाद, दस्तऐवज साधने, तत्काळ अनुवाद आणि ऑडिओ व व्हिडिओ सेवा यांची किंमत प्रत्यक्ष वापरानुसार ठरवली जाते; एखादी कार्य तयार करणे ही अंतिम शुल्क नाही.
काम सुरू होण्यापूर्वी, फक्त शिल्लक जादा मर्यादा तपासली जाते; काम पूर्ण झाल्यानंतर प्रत्यक्ष वापराचे शुल्क आकारले जाते. जर शिल्लक पुरेसे नसेल, तर तफावत कर्ज म्हणून नोंदवली जाते आणि नंतर आलेल्या क्रेडिटमधून ते प्रथम भरले जाते. आपण प्रति काम किंवा प्रति क्रेडिट ऑपरेशननुसार शुल्क आणि परताव्याचे समन्वय करू शकता. एखाद्या कीचे बजेट संपल्यावरही, आपण त्या की अंतर्गत असलेल्या कामे, परिणाम आणि नोंदी विचारू शकता.