REST API के माध्यम से LLM का उपयोग करके दस्तावेज़ डेटा निकालें
के साथ शुरू
स्रोत दस्तावेज़
इसके लिए काम करें
एक संरचित एपीआई प्रतिक्रिया
उदाहरण स्रोत
स्रोत दस्तावेज़
- स्कोप की गई कुंजियाँ
- विराम अवस्था में हैश किया गया, निरस्त करने योग्य, गुप्त जानकारी एक बार दिखाई गई
- प्रमाणीकरण
- प्राधिकरण: बियरर या X-API-कुंजी
- वर्ज़न्ड एंडपॉइंट्स
- GET /api/v1/extractions, GET :id/export, POST /api/v1/infer
एक दस्तावेज़ अनुरोध। नामित फ़ील्ड वापस।
इनपुट + आउटपुट: /api/v1/extractions, /api/v1/infer, /api/tokens
समीक्षा की गई सामग्री .
Put the document extraction API inside your product, CI job or internal tool. Create a scoped key, send it as Authorization: Bearer dd_live_<key> or X-API-Key, and POST the file to /api/v1/infer. The versioned API returns structured rows without a browser session, so your code can validate the response and decide what happens next.
इस इंटीग्रेशन को ऐप में खोलें या सार्वजनिक एपीआई और वेबहुक गाइड पढ़ें ।
मैन्युअल निर्यात बटन एक API नहीं है।
- यदि किसी व्यक्ति को एक्सपोर्ट पर क्लिक करना पड़ता है, तो उससे संबंधित सभी कार्य उस व्यक्ति के आने का इंतजार करते हैं।
- स्क्रिप्ट को सीमित दायरे वाले स्थिर क्रेडेंशियल की आवश्यकता होती है। ब्राउज़र सेशन कुकी इसके लिए उपयुक्त उपकरण नहीं है।
- प्रतिक्रिया में पूर्वानुमानित पंक्तियाँ, मेटाडेटा और त्रुटियाँ होनी चाहिए जिन्हें कोड मान्य कर सके।
- एक ऐसा टोकन जो सब कुछ कर सकता है, एक बार कोडबेस में शामिल हो जाने के बाद दीर्घकालिक बोझ बन जाता है।
एपीआई कैसे काम करता है
01. एक स्कोप्ड कुंजी बनाएँ
From the app header under Webhooks & API (or /app?modal=webhooks), mint a scoped key. Keys look like dd_live_<64 hex>. The server stores only their SHA-256 hash, and the full secret is shown exactly once. Manage (list, revoke) them from the same panel.
02. /api/v1 से एक्सट्रैक्शन प्राप्त करें
GET /api/v1/extractions lists your tables with pagination and filtering; GET /api/v1/extractions/:id/export?format=csv|json|xlsx returns one in the format your pipeline consumes. Send your key via the Authorization: Bearer <key> header or X-API-Key header.
03. या किसी दस्तावेज़ से अनुमान लगाना
POST /api/v1/infer कमांड एक दस्तावेज़ (multipart/form-data) अपलोड करता है और ऐप के समान एक्सट्रैक्शन इंजन चलाता है, जिससे प्रतिक्रिया में संरचित तालिका प्राप्त होती है। इसे एक API कॉल माना जाता है। सफल होस्टेड पेज और फ्री या स्टार्टर BYOK पेज मासिक PE बजट से उपयोग किए जाते हैं ; प्रो या स्केल BYOK पेजों का PE शुल्क 0 होता है। एक्सट्रैक्शन स्थायी होते हैं और वेबहुक ट्रिगर करते हैं। इंटरैक्टिव POST /api/extract/infer कमांड सत्र-प्रमाणित कॉल के लिए उपलब्ध रहता है।
04. इसे अपने सिस्टम में डालें
JSON फॉर्मेट सीधे आपके पाइपलाइन में जुड़ जाता है: एक खरीद प्रणाली जो इनवॉइस पंक्तियों को ग्रहण करती है, एक वित्त उपकरण जो बैंक स्टेटमेंट लेनदेन आयात करता है। फॉर्मेट एक जैसा है, इसलिए एक ही उपभोक्ता सभी प्रकार के दस्तावेज़ों को संभालता है।
एपीआई क्या उजागर करता है
वर्ज़न्ड एपीआई उन कॉल्स को एक्सपोज़ करता है जिनकी एक डॉक्यूमेंट पाइपलाइन को आवश्यकता होती है:
- स्कोपयुक्त कुंजियाँ: भंडारण के समय हैश की गई, निरस्त करने योग्य, गुप्त कुंजी एक बार दिखाई जाती है
- प्रमाणीकरण: प्राधिकरण: बियरर या X-API-कुंजी
- वर्ज़न्ड एंडपॉइंट्स: GET /api/v1/extractions, GET :id/export, POST /api/v1/infer
- पेजिंग और फ़िल्टर: पेज, लिमिट, सॉर्ट, ऑर्डर, डॉक_टाइप
- फॉर्मेट: CSV (UTF-8 BOM), JSON, XLSX
- निष्कर्ष: POST /api/v1/infer (मल्टीपार्ट अपलोड)
- उपयोग मापन: GET /api/v1/usage (मासिक सीमा के मुकाबले कॉल)
- दर सीमा: 60/मिनट प्रति कुंजी, 20/मिनट अनुमान
एक यथार्थवादी उदाहरण
दो कॉल में पूरा एकीकरण, शुरू से अंत तक:
| पुकारना | उद्देश्य | रिटर्न |
|---|---|---|
| POST /api/tokens (सेशन प्रमाणीकरण) | एक सीमित दायरे वाली API कुंजी बनाएँ | dd_live_<64 hex>, shown once |
| GET /api/v1/extractions/<id>/export?format=json (Bearer / X-API-Key) | चाबी से बाहर निकालें | { कॉलम, पंक्तियाँ, मेटाडेटा, दस्तावेज़ प्रकार } |
अनुरोध और प्रतिक्रिया के उदाहरण
एक्सट्रैक्शन को JSON फॉर्मेट में एक्सपोर्ट करें
GET /api/v1/extractions/:id/export?format=json
curl -X GET \ -H "Authorization: Bearer dd_live_a8f92b7c4d1e0394..." \ "https://app.dynamitedocs.com/api/v1/extractions/ext_01j5x9b3/export?format=json"
{
"id": "ext_01j5x9b3",
"fileId": "file_8829f0",
"fileName": "vendor_invoice_1092.pdf",
"docType": "Invoice",
"label": "August Operations",
"columns": [
"Invoice Number",
"Date",
"Vendor",
"Description",
"Line Total",
"Tax",
"Amount Due"
],
"rows": [
[
"INV-1092",
"2026-08-01",
"Acme Industrial Ltd",
"Precision CNC milling components",
"$1,250.00",
"$100.00",
"$1,350.00"
]
],
"metadata": {
"vendor": "Acme Industrial Ltd",
"invoice_number": "INV-1092",
"total": "1350.00",
"currency": "USD"
},
"confidence": 0.98,
"fieldConfidence": {
"Invoice Number": 0.99,
"Amount Due": 0.98
},
"summary": "Vendor invoice from Acme Industrial Ltd totaling $1,350.00.",
"createdAt": "2026-08-15T09:12:00.000Z"
}
निष्कर्ष हेतु दस्तावेज़ जमा करें
POST /api/v1/infer
curl -X POST \ -H "Authorization: Bearer dd_live_a8f92b7c4d1e0394..." \ -F "file=@invoice.pdf" \ https://app.dynamitedocs.com/api/v1/infer
{
"id": "ext_99a8b7",
"fileId": "file_77c2d1",
"fileName": "invoice.pdf",
"docType": "Invoice",
"columns": ["Invoice #", "Vendor", "Due Date", "Total"],
"rows": [
["INV-4410", "Apex Logistics", "2026-08-30", "$3,420.00"]
],
"metadata": {
"vendor": "Apex Logistics",
"total": "3420.00",
"currency": "USD"
},
"confidence": 0.97,
"createdAt": "2026-08-22T14:10:00.000Z"
}
पृष्ठीयकरण के साथ सूची निष्कर्षण
GET /api/v1/extractions?page=1&limit=20&sort=created_at&order=desc
curl -X GET \ -H "X-API-Key: dd_live_a8f92b7c4d1e0394..." \ "https://app.dynamitedocs.com/api/v1/extractions?page=1&limit=20&doc_type=Invoice"
{
"data": [
{
"id": "ext_01j5x9b3",
"fileId": "file_8829f0",
"fileName": "vendor_invoice_1092.pdf",
"docType": "Invoice",
"columns": ["Invoice Number", "Vendor", "Amount Due"],
"rows": [["INV-1092", "Acme Industrial Ltd", "$1,350.00"]],
"confidence": 0.98,
"createdAt": "2026-08-15T09:12:00.000Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 48,
"totalPages": 3,
"hasMore": true
}
}
मासिक एपीआई उपयोग की जाँच करें
GET /api/v1/usage
curl -X GET \ -H "Authorization: Bearer dd_live_a8f92b7c4d1e0394..." \ https://app.dynamitedocs.com/api/v1/usage
{
"usage": {
"month": "2026-08",
"calls": 42,
"limit": 5000,
"remaining": 4958,
"unlimited": false
}
}
इस पर भरोसा करने से पहले किन बातों की पुष्टि करनी चाहिए
प्रत्येक कॉल पर प्रतिक्रिया स्थिति और उपयोग हेडर की जांच करें; 401 का मतलब है कि कुंजी अमान्य है, जबकि 429 का मतलब हो सकता है कि प्रति मिनट सीमा या मासिक एपीआई भत्ता सीमा तक पहुंच गया है।
एपीआई ही किसी उपकरण और प्लंबिंग के बीच का अंतर है।
एक बटन पर क्लिक करके एक्सपोर्ट किया जा सकने वाला एक्सट्रैक्शन रिपोर्ट कहलाता है; टोकन-प्रमाणित GET अनुरोध द्वारा प्राप्त किया जा सकने वाला एक्सट्रैक्शन इंटीग्रेशन कहलाता है। API का उद्देश्य दस्तावेज़ डेटा को उन सिस्टमों में स्थानांतरित करना है जो पहले से ही व्यवसाय, खरीद और लेखांकन का संचालन करते हैं, बिना किसी मानवीय हस्तक्षेप के। चाहे वित्त टीम विक्रेता चालान की पंक्तियों को अपने लेखांकन स्टैक में शामिल कर रही हो, या सहायता टीम आने वाले ईमेल से संरचित डेटा को टिकट में डाल रही हो, API संपूर्ण इंटीग्रेशन का काम करता है।
टोकन डिज़ाइन में सुरक्षा सीमा का विशेष ध्यान रखा जाता है। एक कुंजी एक्सट्रैक्शन को सूचीबद्ध और निर्यात कर सकती है, इसके उपयोग की जाँच कर सकती है और अनुमान के लिए दस्तावेज़ सबमिट कर सकती है। यह फ़ाइलें डिलीट नहीं कर सकती, सेटिंग्स नहीं बदल सकती या बिलिंग को प्रभावित नहीं कर सकती। सर्वर केवल SHA-256 हैश को स्टोर करता है, इसलिए डेटाबेस डंप से कोई उपयोगी क्रेडेंशियल प्राप्त नहीं होता है। पूरा टोकन निर्माण के समय केवल एक बार प्रदर्शित होता है और इसे स्वतंत्र रूप से रद्द किया जा सकता है।
Callers can send a token in either the standard Authorization header, Authorization: Bearer dd_live_<key>, or the X-API-Key header. Both options work across all /api/v1 endpoints in curl, Postman, backend services and automation tools.
निर्यात पेलोड में कॉलम, पंक्तियाँ, मेटाडेटा और दस्तावेज़ प्रकार शामिल हैं। CSV में UTF-8 BOM शामिल है, इसलिए Excel उच्चारण वाले अक्षरों को सही ढंग से खोलता है। JSON पाइपलाइन द्वारा उपयोग की जाने वाली संरचना को वहन करता है, जबकि XLSX स्प्रेडशीट कार्य के लिए एक वर्कबुक बनाता है। API का संस्करण /api/v1 के अंतर्गत है, और सूची एंडपॉइंट डेटाबेस में संपूर्ण खाता इतिहास एक साथ लौटाने के बजाय पेजिंग और फ़िल्टरिंग करता है।
प्रत्येक प्रमाणित /api/v1 अनुरोध की गणना खाते के मासिक API कॉल भत्ते और प्रति कुंजी गेटकीपर द्वारा निर्धारित दर सीमा (डिफ़ॉल्ट 60/मिनट) के आधार पर की जाती है। काउंटर उसी उपयोग लेजर में रहता है जिसमें ऐप डेटा लिखता है, इसलिए डेवलपर को GET /api/v1/usage में जो संख्या दिखाई देती है, वही संख्या सर्वर द्वारा लागू की जाती है। कुंजी को निरस्त करने से उसका हैश हट जाता है और अगला अनुरोध अस्वीकार कर दिया जाता है, यही कारण है कि किसी लीक हुई कुंजी को सार्वजनिक रिपॉजिटरी में पेस्ट करना एक क्लिक का समाधान है, कोई आपातकालीन स्थिति नहीं।
स्टैंडअलोन इन्फ़रेंस अंतिम कमी को पूरा करता है। POST /api/v1/infer एक मल्टीपार्ट दस्तावेज़ स्वीकार करता है, संरचित तालिका लौटाता है, कुंजी स्वामी के लिए निष्कर्षण को सहेजता है, और कॉन्फ़िगर किए गए वेबहुक को ट्रिगर करता है। होस्टेड रन इंटरैक्टिव ऐप के समान पेज कैप और पीई बजट का उपयोग करते हैं। फ्री और स्टार्टर प्लान पर BYOK उसी पीई बजट को साझा करता है; प्रो और स्केल प्लान पर BYOK असीमित है। प्रत्येक अनुरोध अभी भी प्लान के API-कॉल भत्ते के अंतर्गत गिना जाता है।
एपीआई क्या करता है और क्या नहीं करता है
करता है
- यह बियरर या एक्स-एपीआई-की प्रमाणीकरण के साथ संस्करणित /api/v1 एंडपॉइंट के माध्यम से निष्कर्षण और निर्यात प्रारूपों तक कुंजी-प्रमाणित पहुंच प्रदान करता है।
- यह कुंजियों को केवल SHA-256 हैश के रूप में संग्रहीत करता है और निर्माण के समय केवल एक बार ही मूल गुप्त कुंजी दिखाता है।
- प्रत्येक कुंजी के लिए दर सीमा निर्धारित है और उपयोग बिंदु के साथ मासिक भत्ते के आधार पर प्रत्येक कॉल की गणना की जाती है।
- स्टैंडअलोन इन्फ़रेंस पर होस्टेड पेज कैप और मासिक पीई बजट लागू होता है। फ्री और स्टार्टर प्लान में BYOK सीमित है; प्रो और स्केल प्लान में BYOK असीमित है।
नहीं
- यह फ़ाइल, सेटिंग्स, खाता या बिलिंग में किसी भी प्रकार के परिवर्तन को प्रदर्शित नहीं करता है। इन कार्यों के लिए आपके सत्र की आवश्यकता होती है।
- यह एपीआई ट्रैफिक को दर सीमाओं, मासिक कॉल भत्ते या प्रोसेसिंग बजट को दरकिनार करने की अनुमति नहीं देता है।
- यह आपकी कुंजी को सर्वर पर कहीं भी सादे टेक्स्ट में संग्रहीत नहीं करता है।
एपीआई को बेसलाइन में क्यों शामिल किया जाना चाहिए
टोकन-प्रमाणित निर्यात प्रत्येक निष्कर्षण को आपके द्वारा पहले से चलाए जा रहे सिस्टम के लिए एक स्थिर डेटा स्रोत में बदल देता है, इसमें किसी मानवीय हस्तक्षेप की आवश्यकता नहीं होती है, और स्क्रिप्ट में किसी सत्र कुकी की आवश्यकता नहीं होती है।
रीड-ओनली, हैश्ड टोकन को पाइपलाइन और वेंडर टूल्स में एम्बेड करना सुरक्षित है, और यही एकमात्र प्रकार का क्रेडेंशियल है जिसे आपको कॉन्फ़िगरेशन में शामिल करना चाहिए।
स्टैंडअलोन इन्फरेंस आपको ऐप के समान सीमाओं और बजट के साथ प्रोग्रामेटिक दस्तावेज़ पढ़ने की सुविधा देता है, इसलिए स्वचालन चुपचाप मूल्य निर्धारण मॉडल का दुरुपयोग नहीं कर सकता है।
सवालों के जवाब
मैं एपीआई कुंजी कैसे बनाऊं?
वेबहुक्स और एपीआई के अंतर्गत वर्कस्पेस हेडर से, या सीधे /app?modal=webhooks के माध्यम से। कुंजी निर्माण के समय एक बार प्रदर्शित होती है और सर्वर-साइड पर SHA-256 हैश के रूप में संग्रहीत होती है।
मैं अपने API कुंजी को अनुरोधों में कैसे भेजूं?
Send your key in the Authorization header with Bearer scheme (Authorization: Bearer dd_live_<key>) or in the X-API-Key header (X-API-Key: dd_live_<key>). Both standard Bearer and custom header authentication are supported across all /api/v1 endpoints.
एक चाबी क्या कर सकती है?
Keys का उपयोग करके एक्सट्रैक्शन को सूचीबद्ध और निर्यात किया जा सकता है, उपयोग की जांच की जा सकती है और /api/v1/infer के माध्यम से दस्तावेज़ सबमिट किए जा सकते हैं। फ़ाइल, सेटिंग्स, खाता और बिलिंग में किए गए परिवर्तन आपके सेशन के दौरान बने रहते हैं।
क्या मैं टोकन रद्द कर सकता हूँ?
जी हां। टोकन को वेबहुक और एपीआई (/app?modal=webhooks) से व्यक्तिगत रूप से रद्द किया जा सकता है, और यह रद्दीकरण तत्काल होता है।
क्या एपीआई मेरे प्लान की सीमाओं का सम्मान करता है?
जी हां। प्रति उपयोगकर्ता/आईपी के हिसाब से अनुमान लगाने की दर सीमित है। सफल होस्ट किए गए पेज और फ्री या स्टार्टर BYOK पेज मासिक PE भत्ते से उपयोग किए जाते हैं। प्रो या स्केल BYOK पेजों की लागत 0 PE है।
संबंधित एकीकरण लेख
एकीकरण कार्यक्षेत्र खोलें , भुगतान विवरण न दें।
के साथ शुरू
स्रोत दस्तावेज़
इसके लिए काम करें
एक संरचित एपीआई प्रतिक्रिया
- 01 एक स्कोप्ड कुंजी बनाएँ
- 02 /api/v1 से एक्सट्रैक्शन खींचें
- 03 या किसी दस्तावेज़ से अनुमान लगाएं
- 04 इसे अपने सिस्टम में डालें
के साथ शुरू
स्रोत दस्तावेज़
इसके लिए काम करें
एक संरचित एपीआई प्रतिक्रिया
उदाहरण स्रोत
स्रोत दस्तावेज़
- स्कोप की गई कुंजियाँ
- विराम अवस्था में हैश किया गया, निरस्त करने योग्य, गुप्त जानकारी एक बार दिखाई गई
- प्रमाणीकरण
- प्राधिकरण: बियरर या X-API-कुंजी
- वर्ज़न्ड एंडपॉइंट्स
- GET /api/v1/extractions, GET :id/export, POST /api/v1/infer
एक दस्तावेज़ अनुरोध। नामित फ़ील्ड वापस।
