एपीआई अवलोकन
Base URL
https://omnidoc.top/api/v1Content-Type: application/json को JSON अनुरोधों के साथ भेजें। API कीज़ X-API-Key हेडर में या Bearer क्रेडेंशियल के रूप में दी जाती है।
सेवाएँ
Section titled “सेवाएँ”| सेवा | मुख्य मार्ग | उद्देश्य |
|---|---|---|
| फ़ाइल अपलोड | /upload/* | दस्तावेज़ अपलोड करें और पुष्टि करें |
| फ़ाइल लाइब्रेरी | /storage/files/*, /documents/* | सूची, पढ़ें और डाउनलोड करें |
| अनुवाद | /jobs/*, /artifacts/* | जॉब्स बनाएं, स्टेटस और परिणाम जांचें |
| दस्तावेज़ उपकरण | /document-operations/*, /file-tools/* | रूपांतरण, मर्जिंग, विभाजन, संकुचन और अधिक |
| तत्काल अनुवाद | /ai/* | लघु पाठ और बैच खंड अनुवाद |
| ऑडियो और वीडियो | /media-jobs/*, /media-voices/* | नौकरियाँ और आवाज़ें |
| शब्दकोश | /glossaries/* | शर्तें, आयात और निर्यात |
| उपयोग और क्रेडिट | /usage/*, /billing/credits/* | उपयोग, शेष राशि और निपटान रिकॉर्ड |
| अधिसूचनाएँ | /sse/*, /webhooks/* | लाइव प्रगति और कॉलबैक |
आप किन सेवाओं को कॉल कर सकते हैं और उनकी लागत क्या है: सेवाएँ और अनुमतियाँ ।
परंपराएँ
Section titled “परंपराएँ”- संसाधन आईडी अपारदर्शी स्ट्रिंग होते हैं।
- निर्माण अनुरोधों के साथ
Idempotency-Keyभेजें; दस्तावेज़ संचालन, मीडिया जॉब्स और वॉयस क्रिएशन के लिए एक की आवश्यकता होती है। - पृष्ठीयकरण पैरामीटरों का विवरण प्रत्येक एंडपॉइंट के पृष्ठ पर दिया गया है।
- Handle
429as described in errors and retries. - डाउनलोड किए गए फ़ाइलों के नाम सिर्फ़ प्रदर्शन के लिए हैं; सहेजने से पहले बेसनेम का उपयोग करें और अपनी फ़ाइल सिस्टम की सीमाओं को लागू करें।
अनुरोध ट्रेसिंग
Section titled “अनुरोध ट्रेसिंग”प्रत्येक प्रतिक्रिया का X-Request-Id रखें। समर्थन से संपर्क करते समय, वह मान, अनुरोध समय और पथ दें; पूरी API कुंजी या फ़ाइल सामग्री कभी न भेजें।