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