प्रोजेक्ट, टैग और साझाकरण
फ़ाइल लाइब्रेरी संसाधनों का मूल स्रोत है; प्रोजेक्ट, टैग और खोज उन्हें व्यवस्थित करने वाले दृश्य हैं। फ़ाइल या दस्तावेज़ ID को बरकरार रखें; स्थिर पहचानकर्ताओं की जगह नामों का उपयोग न करें।
परियोजनाएँ
Section titled “परियोजनाएँ”GET /api/v1/projectsPOST /api/v1/projectsGET /api/v1/projects/{project_id}PATCH /api/v1/projects/{project_id}DELETE /api/v1/projects/{project_id}
POST /api/v1/projects/{project_id}/documentsDELETE /api/v1/projects/{project_id}/documents/{document_id}किसी प्रोजेक्ट में दस्तावेज़ जोड़ने से केवल उसका वर्गीकरण बदलता है: फ़ाइल की प्रतिलिपि नहीं बनाई जाती है और इसका मालिक भी नहीं बदलता।
GET /api/v1/tagsPOST /api/v1/tagsDELETE /api/v1/tags/{tag_id}
POST /api/v1/tags/documents/{document_id}DELETE /api/v1/tags/documents/{document_id}/{tag_id}एक टैग नाम प्रदर्शन के लिए होता है; डिलीट, डिटैच और क्वेरी में टैग आईडी का उपयोग किया जाता है।
GET /api/v1/search?q={query}&limit=20खोज से केवल वे दस्तावेज़ और नौकरियाँ ही प्राप्त होती हैं जिन्हें वर्तमान खाता पढ़ सकता है। खोज एक पठन कार्य है और इसके लिए कोई क्रेडिट नहीं लगता।
लिंक साझा करें
Section titled “लिंक साझा करें”GET /api/v1/sharesPOST /api/v1/sharesGET /api/v1/shares/{token}GET /api/v1/shares/{token}/downloadDELETE /api/v1/shares/{token}POST /shares अनुवाद परिणाम का एक पढ़ने योग्य लिंक बनाता है; इसका शरीर artifact_id और एक वैकल्पिक expires_in_days (1–365; इसके बिना लिंक की समय-सीमा समाप्त नहीं होती) होता है। लिंक रखने वाला कोई भी व्यक्ति डाउनलोड कर सकता है, इसलिए इसे लॉग और एनालिटिक्स पैरामीटर से बाहर रखें और जब आवश्यकता न रहे तो इसे हटा दें।
ऐप वर्कस्पेस
Section titled “ऐप वर्कस्पेस”GET /api/v1/workspace/filesGET /api/v1/workspace/entriesGET /api/v1/workspace/appsये एंडपॉइंट OmniDoc अकाउंट के लिए एकीकृत कार्यस्थान बनाने के लिए हैं। क्लाइंट्स को प्रतिक्रियाओं में दिए गए एंट्रीज़ और क्षमताओं का पालन करना चाहिए और स्वयं ऐप URL नहीं बनाना चाहिए।