दस्तावेज़ और फ़ाइल उपकरण
OmniDoc सिंक्रोनस फ़ाइल टूल्स और ट्रैक करने योग्य एसिंक्रोनस डॉक्यूमेंट ऑपरेशन्स प्रदान करता है। सबसे पहले क्षमता एंडपॉइंट्स को कॉल करें; क्लाइंट में समर्थित फ़ॉर्मेट या सीमाओं को हार्ड-कोड न करें।
क्षमता की खोज
Section titled “क्षमता की खोज”GET /api/v1/document-operations/capabilitiesGET /api/v1/artifacts/convert/capabilitiesये वर्तमान में खुले हुए ऑपरेशनों, उनके इनपुट प्रारूपों, बिलिंग और तकनीकी सीमाओं को वापस देते हैं। unavailable के तहत सूचीबद्ध क्षमताएं नहीं बनाई जा सकतीं।
असिंक्रोनस दस्तावेज़ संचालन
Section titled “असिंक्रोनस दस्तावेज़ संचालन”POST /api/v1/document-operationsIdempotency-Key: unique-request-id{ "document_id": "4q8mx2q9z1k7p6ra", "kind": "visual_extract"}इस एंडपॉइंट के लिए Idempotency-Key की आवश्यकता होती है। kind में वर्तमान में शामिल हैं:
extract: संरचित निष्कर्षण, मुफ़्त।pdf_to_html: PDF से ऑनलाइन HTML, मुफ़्त।visual_extract: दृश्य संरचित निष्कर्षण, प्रति पृष्ठ शुल्क (प्रति पृष्ठ 1 क्रेडिट)। इसके शुरू होने से पहले, इसके द्वारा संसाधित की जा सकने वाली पृष्ठ संख्या बैलेंस से निर्धारित की जाती है (अधिकतम 20 पृष्ठ); यदि बैलेंस 1 पृष्ठ से कम है, तो यह402लौटाता है। जब यह समाप्त होता है, तो वास्तव में संसाधित किए गए पृष्ठों का शुल्क लगाया जाता है, और बैलेंस ऋणात्मक हो सकता है।
जाँचें और रद्द करें:
GET /api/v1/document-operations/{operation_id}GET /api/v1/document-operations?limit=25POST /api/v1/document-operations/{operation_id}/cancelजब यह पूरा हो जाता है, तो प्रतिक्रिया का output_document_id फ़ाइल लाइब्रेरी या किसी अन्य कार्य में जा सकता है, और credit_operation_id समाधान रिकॉर्ड देता है।
PDF टूल्स
Section titled “PDF टूल्स”POST /api/v1/file-tools/pdf/mergePOST /api/v1/file-tools/pdf/splitPOST /api/v1/file-tools/pdf/compressमर्ज का उदाहरण:
{"document_ids":["4q8mx2q9z1k7p6ra","b6t1n8c3v9m2x5ka"]}विभाजन उदाहरण:
{"document_id":"4q8mx2q9z1k7p6ra","ranges":["1-3","5","8-10"]}छवि उपकरण
Section titled “छवि उपकरण”POST /api/v1/file-tools/image/convertPOST /api/v1/file-tools/image/compress{ "document_id": "4q8mx2q9z1k7p6ra", "target_format": "webp", "quality": 85}ये टूल केवल उन दस्तावेज़ों को स्वीकार करते हैं जिनका मालिक वर्तमान खाता है और जिनका प्रकार मिलान रखता है। बाइनरी प्रतिक्रियाओं को स्ट्रीम करें, और फ़ाइल का नाम तथा प्रकार प्रतिक्रिया हेडर्स से लें।