PDF.chat API
Wepu PDF na chat na ya site na ngwa gị - jụọ ajụjụ ma nweta azịza ndị akọwapụtara na peeji, na asụsụ 100 +. Mepụtara na peeji, enweghị ihe ịga nke ọma.
Nlekọta
The PDF.chat API bụ a obere REST interfaịlụ. First ị POST Dọkumenti iji banye ya nakwa nweta ọrụ na ngwe nke dọkumenti ahụ nakwa n'ihuakwụkwọ ọbụla (ngwe, bọ́tị̀nụ̀ banye, n'aka). Mgbe ahụ ị ga-eme ya POST ajụjụ na-emegide na ọrụ na-enweta azịza n'ime akwụkwọ, ọ bụla na-ekwu na peeji nke ọ na-abịa site. ọrụ nke 5 peeji ma ọ bụ na-adịghị na-agbake inline; nnukwu ọrụ na-agbake n'oge na-adịghị na a pending ọnọdụ ị na-enyocha ruo mgbe done.
- Ebe URL:
https://pdf.chat - Dọkumenti na: PDF, nakwa Wụsọ, Powerpoint, ngwe, na inyogo (PNG, JPG, WEBP, GIF, BMP, TIFF)
- Chat n'ime: Ndesịta azịza na ihuakwụkwọ n'ime; n'ime
- ngwe ahụ émepụtara:
txt,md,docx,pdf,csv,json - Ngụnye engine:
cpu(n'ụzọ nkịtị, dócètị̀ mbipụta) navlm(AI premium, handwriting, complex layout, mathematics)
Nkwenye
Nkwenye na Token API (nweta ya na Ihu ebentanet) dịka ihenhọrọ nke elu:
Authorization: Bearer YOUR_API_TOKEN
I nwere ike ịga ?api_token=… dịka paramita nchọgharị. Oji a na-emezigharị n'ebe n'ime ihuakwụkwọ akaụntụ gị.
Dọkumenti ọfụụ
POST /api/v1/ocr/, Ńkwádò multipart
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"
Na-eziga ọrụ ahụ. Maka ≤5-ihuakwụkwọ faịlụ ọ bụ nke ahụ done na ngwe; faịlụ ndị dị ukwuu na-abịa n'ihu pending/processing, pụọ́ n'ókèókè nke ọnọdụ ngwụcha.
{
"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 } ] } ]
}
Wepụta nsonaazụ
GET /api/v1/ocr/<uuid>/, pịa ruo mgbe status bụ done ma ọ bụ failed.
curl https://pdf.chat/api/v1/ocr/9f2c1b7e4a.../ \
-H "Authorization: Bearer YOUR_API_TOKEN"
Bubata usoroiheomume
GET /api/v1/ocr/<uuid>/download/?format=md, wepụ ihenhọrọ ahụ. format otu n'ime 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 na dọkumenti
Nwere ajụjụ banyere ọrụ e mechara. Ajụjụ ndị ahụ bụ naanị n'ime ngwe ahụ e wepụtala ma ọ bụ n'ime ihuakwụkwọ isi. Ekwesịrị akaụntụ token, chat ihenhọrọ bụ akaụntụ-gated.
POST /api/v1/chat/<uuid>/, JSON body {"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?"}'
Na-eziga ozi ndịna na-enye ya nzaghachi na ndesịta nke ihuakwụkwọ ndị ahụ:
{"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/, Wepụta n'ime
Nhazi kood
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?"}'
Paramita
| _Òkè | Ụdị | Ndesịta ozi ndị ahụ |
|---|---|---|
file | file | Ekwesịrị ya. Inyogo mọọbụ PDF a ga-ewepụ. |
tier | string | cpu (dìfọ́ọ̀ltụ̀, n'ihi na/pịa) mọọbụ vlm (premium AI: handwriting, layout, mathematics). |
language | string | auto (dìfọ́ọ̀ltụ̀) mọọbụ koodị asụsụ (en, ch, ja, ar,... |
tool | string | Slug tùlè nke n'aka (eg. summarize-pdf, ask-pdf) ka pre-frame the chat maka na ọrụ. |
Ndehie na nkwụsị
| _Ọdịdị | Nkọwa |
|---|---|
400 | Faịlụ ọbụla, ụdị a na-akwadoghị, mọọbụ faịlụ dị ukwuu. |
401 | Enweghị ma ọ bụ token API ọfụụ. |
402 | N'ime ihuakwụkwọ, n'ụbọchị/ụbọchị ọbụla n'ime ọnwa, ọbụla n'ime kredit. Ogo na-agụnye used/cap. |
404 | Ọrụ UUID achọpụtaghị. |
409 | Nbudata achọrọ tupú ọrụ ahụ gwụchaa. |
Ihu ebe ọbụla na-ejikwa ego kredit (1/ihu ebe n'ime ọsọ ọsọ, karịa na prímáị̀m). Nhazi ego na-eweta ihenhọrọ ihuakwụkwọ na-echekwa na-egbakwunye n'ime faịlụ. Gụọ price.
Ajụjụ ndị a na-ajụkarị
language=auto iji chọpụta, mọọbụ banye koodị pụrụ iche.