PDF.chat API
Hladdu upp PDF og chat með því úr eigin forriti þínu - spyrðu spurninga og fáðu svör sem vitnað er til á síðunni, á 100+ tungumálum.
Yfirlit
The PDF.chat API er lítill REST tengi. Fyrst þú POST Smelltu á skjal til að taka það inn og fá aftur starf með texta skjalsins og hverri síðu niðurbrot (texti, takmarka kassa, traust). POST Verk sem eru 5 blaðsíður eða færri skila sér í línu; stærri verk skila sér strax með skýrslu um hversu mikið er eftir af skjalinu. pending Staða sem þú kjósa þar til done.
- Grunnslóð:
https://pdf.chat - Skjöl í: PDF, auk Word, PowerPoint, texta og myndum (PNG, JPG, WEBP, GIF, BMP, TIFF)
- Chat út: svör með síðu tilvitnanir; afritunar með sögu endapunkti
- Unninn texti út:
txt,md,docx,pdf,csv,json - Lesvél:
cpu(fljótur, prentuð skjöl) ogvlm(Premium AI, handskrift, flókið skipulag, stærðfræði)
Auðkenning
Auðkenna með lykilorði þínu API tákn (finna það á vefsíðunni þinni) reikningssíða) sem Bearer haus:
Authorization: Bearer YOUR_API_TOKEN
Þú getur einnig farið ?api_token=… Notkun er mæld gegn síðujafnvægi reikningsins þíns.
Senda skjal
POST /api/v1/ocr/, Multipart form upload.
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"
Sýnir verk. Fyrir ≤5- síðu skrár er það þegar done með textanum; stærri skrár koma aftur pending/processing, spyrja stöðu endapunkt.
{
"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 } ] } ]
}
Fá niðurstöðu
GET /api/v1/ocr/<uuid>/, könnun þar til status er done eða failed.
curl https://pdf.chat/api/v1/ocr/9f2c1b7e4a.../ \
-H "Authorization: Bearer YOUR_API_TOKEN"
Sækja snið
GET /api/v1/ocr/<uuid>/download/?format=md, Flytja út niðurstöðuna. format er einn af 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
Chat með skjali
Spyrja spurninga um lokið verk. Svör eru eingöngu byggð á útdráttartextanum og vísa á upprunasíðuna. Þarfnast reikningstákns, chat eiginleikinn er reikningstengdur.
POST /api/v1/chat/<uuid>/, JSON líkami {"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?"}'
Sýnir aðstoðarmanninn með svari og lista yfir síður sem vísað er á:
{"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/, Sækja fulla samtal afritun fyrir starf.
Dæmi um kóða
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?"}'
Breytur
| Field | Tegund | Lýsing |
|---|---|---|
file | file | Nauðsynlegt. Myndin eða PDF til að vinna. |
tier | string | cpu (sjálfgefið, hratt/prentað) eða vlm (Premium AI: handrit, skipulag, stærðfræði). |
language | string | auto (sjálfgefið) eða tungumálakóða (en, ch, ja, ar, …). |
tool | string | Valfrjálst verkfæri snigla (t.d. summarize-pdf, ask-pdf) til að pre-frame chat fyrir þetta verkefni. |
Villur og takmörk
| Kóði | Merking |
|---|---|
400 | Engin skrá, óstudd tegund eða skrá of stór. |
401 | Vantar eða ógilt API tákn. |
402 | Út af síðum, daglegt/mánaðarlegt ókeypis takmark náð, eða engin einkunn. used/cap. |
404 | Verk UUID fannst ekki. |
409 | Beiðni um niðurhal var send áður en verkinu lauk. |
Hver blaðsíða sem unnið er kostar einingar (1 / síða á hraða stigi, meira á hágæða). Greiddar áætlanir hækka síðuhaf á skrá og bæta við forgang. verðlagning.
Algengar spurningar
language=auto til að greina eða fara framhjá tilteknum kóða.