PDFLean
API संदर्भ

वर्कफ़्लो API

जब तक कि अन्यथा उल्लेख न किया गया हो, सभी एंडपॉइंट के लिए साइन-इन सत्र (cookie) आवश्यक है। प्रतिक्रियाएँ JSON होती हैं: { ok: true, data } या { ok: false, error }। सामान्य त्रुटियाँ: 400 सत्यापन, 401 अप्रमाणित, 403 निषिद्ध, 404 नहीं मिला, 429 दर-सीमित, 502/503 अपस्ट्रीम। सार्वजनिक /api/v1 एंडपॉइंट Authorization: Bearer pdflean_… से प्रमाणीकरण करते हैं और JSON कंटेंट टाइप भेजना आवश्यक है।

इस पृष्ठ पर

वर्कफ़्लोज़

विधिपथविवरण
GET/api/workflowsअपने वर्कफ़्लो सूचीबद्ध करें
POST/api/workflowsवर्कफ़्लो (ड्राफ्ट) बनाएं
GET/api/workflows/:idवर्कफ़्लो प्राप्त करें
PUT/api/workflows/:idवर्कफ़्लो अपडेट करें (ड्राफ्ट, संस्करण+1)
DELETE/api/workflows/:idवर्कफ़्लो हटाएं
POST/api/workflows/:id/publishएक संस्करण प्रकाशित करें
GET/api/workflows/:id/versionsसंस्करण सूचीबद्ध करें
POST/api/workflows/:id/versions/:version/restoreएक संस्करण पुनर्स्थापित करें

ट्रिगर और हुक

विधिपथविवरण
GET/api/workflows/triggersट्रिगर्स सूचीबद्ध करें
POST/api/workflows/triggersएक ट्रिगर बनाएं (वेबहुक/शेड्यूल/ईमेल/ड्राइव)
POST/api/workflows/triggers/:id/runअभी एक ट्रिगर चलाएं
DELETE/api/workflows/triggers/:idएक ट्रिगर हटाएं
POST/api/workflows/hook/:tokenइनबाउंड वेबहुक (टोकन ऑथ, कोई सेशन नहीं; JSON बॉडी)

रन और समीक्षाएं

विधिपथविवरण
POST/api/workflows/runsएक रन बनाएं (क़तारबद्ध)
GET/api/workflows/runsरन सूचीबद्ध करें
GET/api/workflows/runs/:idरन विवरण और चरण
POST/api/workflows/runs/:id/retryविफल/कतारबद्ध रन पुनः प्रयास करें
GET/api/workflows/reviewsलंबित मानवीय समीक्षाएं
POST/api/workflows/reviews/:idसमीक्षा स्वीकृत/अस्वीकृत करें

क्लाउड ब्रिज

विधिपथविवरण
GET/api/workflows/cloud/statusस्टैंडअलोन VPS ब्रिज स्थिति
POST/api/workflows/cloud/convertऑफिस → PDF, स्टैंडअलोन VPS (LibreOffice) के माध्यम से
POST/api/workflows/cloud/ocrस्टैंडअलोन VPS (Tesseract) के माध्यम से OCR
POST/api/workflows/cloud/extractPDF से इनवॉइस/सामान्य फ़ील्ड निकालें (pdfjs + rules)

संग्रह और प्रतिधारण

विधिपथविवरण
GET/api/workflows/archiveसंग्रहीत दस्तावेज़ और श्रृंखला अखंडता सूचीबद्ध करें
POST/api/workflows/archiveएक दस्तावेज़ संग्रहीत करें (base64, SHA-256 हैश चेन)
GET/api/workflows/archive/:id/verifyसंग्रह हैश चेन सत्यापित करें
GET/api/workflows/archive/exportसंग्रहीत ऑडिट CSV निर्यात करें (टॉम्बस्टोन शामिल)
POST/api/workflows/archive/:id/holdलीगल होल्ड लागू/हटाएं
POST/api/workflows/archive/:id/complianceअपरिवर्तनीय WORM अनुपालन लॉक सक्षम करें
DELETE/api/workflows/archive/:idएक संग्रह हटाएं (लीगल होल्ड के तहत अवरुद्ध)

सार्वजनिक API v1

विधिपथविवरण
GET/api/v1/openapi.jsonOpenAPI 3.1 स्पेक (सार्वजनिक, कोई प्रमाणीकरण नहीं)
GET/api/v1/meवर्तमान API कुंजी मालिक (Bearer कुंजी)
GET/api/v1/usageउपयोग डैशबोर्ड: शेष राशि, 30-दिन का इतिहास, हाल की कॉल्स
GET/api/v1/workflowsवर्कफ़्लो सूचीबद्ध करें (स्कोप workflow.read)
GET/api/v1/workflows/:idएक वर्कफ़्लो प्राप्त करें (स्कोप workflow.read)
POST/api/v1/workflows/:id/runएक रन कतार में लगाएँ (स्कोप workflow.run)
GET/api/v1/runsरन सूचीबद्ध करें (स्कोप workflow.read)
POST/api/v1/pdf/mergePDF मर्ज करें (स्कोप pdf.merge; 2–10 base64 फ़ाइलें)
POST/api/v1/pdf/splitचयनित पृष्ठ रखें (स्कोप pdf.split; "1-3,5" जैसी श्रेणियाँ)
POST/api/v1/pdf/compressPDF को संरचनात्मक रूप से संपीड़ित करें (स्कोप pdf.compress)
GET/api/v1/jobs/:idजॉब स्थिति (मुफ़्त)
GET/api/v1/jobs/:id/downloadजॉब परिणाम डाउनलोड करें (मुफ़्त)
POST/api/v1/convert/officeOffice/ODF दस्तावेज़ परिवर्तित करें (स्कोप pdf.convert)
POST/api/v1/convert/linearizeतेज़ वेब व्यू के लिए PDF को लीनियराइज़ करें (स्कोप pdf.convert)
POST/api/v1/convert/typstTypst/Markdown स्रोत को PDF में संकलित करें (स्कोप pdf.convert)
POST/api/v1/ocrस्कैन किए गए PDF को खोजने योग्य PDF में OCR करें (स्कोप pdf.ocr)
POST/api/v1/ocr/textएक छवि को OCR करके टेक्स्ट में बदलें (स्कोप pdf.ocr)
POST/api/v1/validate/pdfaPDF/A अनुपालन जाँच (स्कोप pdf.validate)
POST/api/v1/validate/pdfuaPDF/UA पहुँच-योग्यता जाँच (स्कोप pdf.validate)
POST/api/v1/validate/signatureडिजिटल हस्ताक्षर सत्यापन रिपोर्ट (स्कोप pdf.validate)
POST/api/v1/signPAdES डिजिटल हस्ताक्षर (स्कोप pdf.sign; वैकल्पिक PEM कुंजी युग्म)
POST/api/v1/redactटेक्स्ट मिलान या क्षेत्रों का वास्तविक रिडैक्शन (स्कोप pdf.redact)
POST/api/v1/extractटेक्स्ट और नियम-आधारित फ़ील्ड निष्कर्षण (स्कोप pdf.extract)
POST/api/v1/doclingDocling के माध्यम से संरचित लेआउट पार्सिंग (स्कोप pdf.extract)
POST/api/v1/scan/piiव्यक्तिगत जानकारी के लिए टेक्स्ट स्कैन करें (स्कोप pii.detect)

Credit consumption

Member credits refresh each billing cycle (no rollover) and are spent before purchased credits. Credits are $0.001 each.

Top up API credits in your account (from $5, never expires)

MethodEndpointCredits
GET/jobs/:id0 per call
GET/jobs/:id/download0 per call
GET/me0 per call
GET/runs0 per call
GET/usage0 per call
GET/workflows0 per call
GET/workflows/:id0 per call
POST/ai/chat3 per call
POST/ai/extract5 per call
POST/ai/pii-detect4 per call
POST/ai/summarize3 per call
POST/ai/translate3 per call
POST/convert/linearize1 per call
POST/convert/office2 per call
POST/convert/typst1 per call
POST/docling3 per call
POST/extract2 per call
POST/ocr3 per page
POST/ocr/text1 per call
POST/pdf/compress1 per call
POST/pdf/merge1 per call
POST/pdf/split1 per call
POST/redact3 per call
POST/scan/pii2 per call
POST/sign5 per envelope
POST/validate/pdfa2 per call
POST/validate/pdfua2 per call
POST/validate/signature2 per call
POST/workflows/:id/run1 per call
ai.chat2 per call
convert.html_to_pdf4 per page
convert.office_to_pdf10 per page
convert.pdf_to_office12 per page
convert.pdfa8 per page
esign.envelope750 per envelope
pdf.ocr3 per page
pdf.ocr.high8 per page