PDF.chat एपीआई

ओवरव्यू

PDF.chat एपीआई एक छोटा सा प्रक्षेपक इंटरफेस है. पहले आप POST दस्तावेज़ के पाठ और प्रति- पृष्ठ- पृष्ठ- अप ब्रेक ब्रेक (पाठ, बक्स, भरोसा) के साथ एक दस्तावेज़ प्राप्त करने के लिए दस्तावेज़. POST उस कार्य के विरुद्ध प्रश्‍न और दस्तावेज़ में आधार पर जवाब पाने के लिए, हर पन्‍ने से वह शब्द आया । pending स्थिति कि आप खर्च जब तक done.

• आधार यूआरएल: https://pdf.chat
• दस्तावेज़ में: पीडीएफ, प्लस वर्ड, पावरपाइंट, पाठ, और छवियों (PPG, JPG, JPG, WF, जीबी, lF, रेड, टिफ)
• Chat बाहर: पृष्ठ उद्धरण के साथ जवाब; इतिहास अंत- बिन्दु के द्वारा उद्धरण
• प्रोसेस्ड पाठ बाहर: txt, md, docx, pdf, csv, json
• इंजन पढ़ा जा रहा है: cpu (तेज, मुद्रित डॉट्स) और vlm (प्रेनियम एआई, हस्तलिपि, जटिल ख़ाका, गणित)

सत्यापन

अपने साथ सत्यापित करें एपीआई टोकन (यह आप पर डाल खाता पृष्ठएक भालू हेडर के रूप में:

Authorization: Bearer YOUR_API_TOKEN

आप भी पार कर सकते हैं ?api_token=… एक क्वैरी पैरामीटर के रूप में. उपयोग को आपके खाता के पृष्ठ के अनुरूप मीटर ऊँचा किया गया है.

दस्तावेज जमा करें

POST /api/v1/ocr/, बहु- पार्ट फ़ॉर्म अपलोड.

curl -X POST https://pdf.chat/api/v1/ocr/ \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file=@invoice.pdf" \
  -F "tier=vlm" \
  -F "language=auto"

कार्य लौटाता है. GEST5-पेज फाइलों के लिए यह पहले से ही है done पाठ के साथ; बड़ी फ़ाइलें वापस आई हैं pending/processing, स्थिति अंत बिन्दु को सर्वे करें.

{
  "uuid": "9f2c1b7e4a...",
  "status": "done",
  "tier": "vlm",
  "language": "auto",
  "page_count": 1,
  "mean_confidence": 0.98,
  "text": "INVOICE\nAcme Corp\nTotal: 215.00 USD",
  "markdown": "# INVOICE\n\n**Acme Corp** ...",
  "pages": [ { "index": 0, "text": "...", "blocks": [ { "text": "...", "bbox": [x0,y0,x1,y1], "confidence": 0.98 } ] } ]
}

परिणाम प्राप्त करें

GET /api/v1/ocr/<uuid>/, तब तक सर्वे status है done या failed.

curl https://pdf.chat/api/v1/ocr/9f2c1b7e4a.../ \
  -H "Authorization: Bearer YOUR_API_TOKEN"

फ़ॉर्मेट डाउनलोड करें

GET /api/v1/ocr/<uuid>/download/?format=md, परिणाम निर्यात करें. format एक का txt, md, docx, pdf, csv, json.

curl -L "https://pdf.chat/api/v1/ocr/9f2c1b7e4a.../download/?format=docx" \
  -H "Authorization: Bearer YOUR_API_TOKEN" -o result.docx

दस्तावेज़ के साथ Chat00

एक पूर्ण कार्य के बारे में प्रश्न पूछें. उत्तर केवल निकाले गए पाठ में हैं तथा स्रोत पृष्ठ का उल्लेख करें. एक खाता टोकन की जरूरत है, chat फीचर खाता तैयार किया जाता है.

POST /api/v1/chat/<uuid>/, JSON शरीर {"message": "your question"}.

curl -X POST https://pdf.chat/api/v1/chat/9f2c1b7e4a.../ \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"message": "What is the invoice total and due date?"}'

सहायक संदेश को इसके उत्तर से बताता है तथा उद्धृत पृष्ठों की सूची में बताता है:

{"conversation": "a1b2…", "message": {
   "role": "assistant",
   "content": "The total is $42, due on March 3 (p. 1).",
   "citations": [{"page": 1, "cited_text": "The invoice total is $42…", "document_id": "9f2c1b7e4a…"}]
}}

GET /api/v1/chat/<uuid>/history/, एक नौकरी के लिए पूरा बातचीत की पेशकश लाना.

कोड उदाहरण

• Python
• Node.js
• cURL

import requests, time

BASE = "https://pdf.chat/api/v1"
H = {"Authorization": "Bearer YOUR_API_TOKEN"}

# 1. Upload a PDF
with open("contract.pdf", "rb") as f:
    job = requests.post(BASE + "/ocr/", headers=H, files={"file": f}).json()

# 2. Wait until it's ready to chat
while job["status"] in ("pending", "processing"):
    time.sleep(2)
    job = requests.get(f"{BASE}/ocr/{job['uuid']}/", headers=H).json()

# 3. Ask questions — every answer is cited to the page
ans = requests.post(f"{BASE}/chat/{job['uuid']}/", headers=H,
    json={"message": "What is the termination notice period?"}).json()
print(ans["message"]["content"])
print(ans["message"]["citations"])

import fs from "fs";

const BASE = "https://pdf.chat/api/v1";
const H = { Authorization: "Bearer YOUR_API_TOKEN" };

// 1. Upload a PDF
const form = new FormData();
form.append("file", new Blob([fs.readFileSync("contract.pdf")]), "contract.pdf");
let job = await (await fetch(`${BASE}/ocr/`, { method: "POST", headers: H, body: form })).json();

// 2. Wait until it's ready to chat
while (["pending", "processing"].includes(job.status)) {
  await new Promise(r => setTimeout(r, 2000));
  job = await (await fetch(`${BASE}/ocr/${job.uuid}/`, { headers: H })).json();
}

// 3. Ask questions — every answer is cited to the page
const ans = await (await fetch(`${BASE}/chat/${job.uuid}/`, {
  method: "POST", headers: { ...H, "Content-Type": "application/json" },
  body: JSON.stringify({ message: "What is the termination notice period?" })
})).json();
console.log(ans.message.content, ans.message.citations);

# 1. Upload a PDF
curl -X POST https://pdf.chat/api/v1/ocr/ \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file=@contract.pdf"

# 2. Ask questions (use the uuid from step 1) — answers cited to the page
curl -X POST https://pdf.chat/api/v1/chat/UUID/ \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"message": "What is the termination notice period?"}'

पैरामीटर्स

त्रुटियाँ (u)

प्रत्येक पृष्ठ के खर्चों का श्रेय (1/पेज जो तेज टाई पर है, अधिक से अधिक हैमियम पर. Pid योजना प्रति- फ़ाइल पृष्ठ रीफ्रेशंश और जोड़ने पर निर्भर करता है. स्केलिंग.

बार बार पूछे जाने वाले प्रश्न