फ़ाइल लाइब्रेरी
फ़ाइल लाइब्रेरी वे स्रोत फ़ाइलें, जॉब परिणाम और ऐप फ़ाइलें प्रदर्शित करती है जिन तक वर्तमान खाता एक्सेस कर सकता है। प्रत्येक आइटम में एक स्थिर file_id होता है और यह उन क्रियाओं को वापस करता है जो कॉलर वर्तमान में कर सकता है।
अनुवाद के इनपुट के रूप में उपयोग किए जाने वाले दस्तावेज़ों में भी /api/v1/documents सूची, विवरण, अद्यतन और हटाने के एंडपॉइंट होते हैं। document_id प्रोसेसिंग जॉब बनाने के लिए है; file_id लाइब्रेरी-व्यापी अधिकारों और डाउनलोड के लिए है। यह मान लेने का कोई कारण नहीं है कि ये दोनों आईडी एक-दूसरे के समान हैं।
सूची और विवरण
Section titled “सूची और विवरण”GET /api/v1/storage/files?offset=0&limit=50GET /api/v1/storage/files/{file_id}सूची प्रतिक्रिया:
{ "items": [ { "id": "x7m4q2k9n6c1v8pa", "name": "report.docx", "content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "size_bytes": 45678, "status": "ready", "publication_status": "draft", "origin": { "product_code": "omnidoc-main", "display_name": "OmniDoc" }, "capabilities": { "can_view": true, "can_download": true, "can_update": true, "can_delete": true, "can_share": true }, "created_at": "2026-10-01T12:00:00Z", "updated_at": "2026-10-01T12:00:00Z" } ], "has_more": true, "next_offset": 50}अगला पृष्ठ प्राप्त करने के लिए, next_offset को offset के रूप में पास करें; जब has_more false हो, तब रोकें।
हमेशा प्रत्येक आइटम के capabilities का उपयोग करके तय करें कि क्या इसे डाउनलोड, साझा या किसी ऐप को अधिकृत किया जा सकता है; मूल क्षेत्रों से अनुमतियों का अनुमान न लगाएं।
डाउनलोड करें
Section titled “डाउनलोड करें”GET /api/v1/storage/files/{file_id}/contentPOST /api/v1/storage/files/{file_id}/download-ticket/content रीडायरेक्ट (302) को एक अल्पकालिक डाउनलोड पते पर भेजता है; रीडायरेक्ट का अनुसरण करते समय API कुंजी न भेजें। पहले download-ticket का अनुरोध करने की सलाह दी जाती है। एक पते के समाप्त होने के बाद नया पता माँगें; इसे संग्रहित न करें।
अनुमतियाँ और लिंक
Section titled “अनुमतियाँ और लिंक”GET /api/v1/storage/files/{file_id}/permissionsPOST /api/v1/storage/files/{file_id}/permissionsDELETE /api/v1/storage/files/{file_id}/permissions/{grant_id}
GET /api/v1/storage/files/{file_id}/linksPOST /api/v1/storage/files/{file_id}/linksDELETE /api/v1/storage/files/{file_id}/links/{link_id}अनुमति परिवर्तन और सार्वजनिक लिंक अलग-अलग क्षमताएं हैं। जब आप कोई लिंक बनाते हैं, तो उसके दर्शक, डाउनलोड अनुमति, समाप्ति तिथि और वैकल्पिक डाउनलोड संख्या को स्पष्ट रूप से निर्धारित करें; जब भी इसकी आवश्यकता न रहे, तो इसे तुरंत रद्द कर दें।
वर्कस्पेस व्यूज़
Section titled “वर्कस्पेस व्यूज़”GET /api/v1/workspace/filesGET /api/v1/workspace/entriesGET /api/v1/workspace/appsवर्कस्पेस एंडपॉइंट एक फ़ाइल सेंटर के लिए उपयुक्त हैं; /storage/files एक ही फ़ाइल पर अनुमति और डाउनलोड कार्रवाइयों के लिए उपयुक्त है।