跳转到内容

दस्तऐवज आणि फाइल साधने

OmniDoc समकालीन फाइल साधने आणि ट्रॅक करण्यायोग्य असमकालीन दस्तऐवज ऑपरेशन्स प्रदान करते. सर्वप्रथम क्षमता एंडपॉइंट्स कॉल करा; ग्राहकामध्ये समर्थित स्वरूपे किंवा मर्यादा हार्ड-कोड करू नका.

GET /api/v1/document-operations/capabilities
GET /api/v1/artifacts/convert/capabilities

या सध्या उघड असलेल्या ऑपरेशन्स, त्यांचे इनपुट फॉरमॅट, बिलिंग आणि तांत्रिक मर्यादा परत करतात. unavailable अंतर्गत सूचीबद्ध क्षमता तयार केल्या जाऊ शकत नाहीत.

असमक्रमित दस्तऐवज ऑपरेशन्स

Section titled “असमक्रमित दस्तऐवज ऑपरेशन्स”
POST /api/v1/document-operations
Idempotency-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=25
POST /api/v1/document-operations/{operation_id}/cancel

ते पूर्ण झाल्यावर, प्रतिसादाचा output_document_id फाइल लायब्ररीमध्ये किंवा दुसऱ्या जॉबमध्ये जाऊ शकतो, आणि credit_operation_id हे सेटलमेंट रेकॉर्ड देते.

POST /api/v1/file-tools/pdf/merge
POST /api/v1/file-tools/pdf/split
POST /api/v1/file-tools/pdf/compress

एकत्रीकरण उदाहरण:

{"document_ids":["4q8mx2q9z1k7p6ra","b6t1n8c3v9m2x5ka"]}

विभाजन उदाहरण:

{"document_id":"4q8mx2q9z1k7p6ra","ranges":["1-3","5","8-10"]}
POST /api/v1/file-tools/image/convert
POST /api/v1/file-tools/image/compress
{
"document_id": "4q8mx2q9z1k7p6ra",
"target_format": "webp",
"quality": 85
}

साधने केवळ चालू खात्याची मालकी असलेली आणि प्रकार जुळणारी कागदपत्रे स्वीकारतात. बायनरी प्रतिसाद प्रवाहित करा आणि फाइल नाव आणि प्रकार प्रतिसाद हेडरमधून घ्या.