PDF.chat API

Přehled

PDF.chat API je malé REST rozhraní. Nejprve vy POST dokument, který jej pohltí a získá zpět práci s textem dokumentu a členěním na stránku (text, svazovací krabice, důvěra). POST otázky proti této práci a získat odpovědi zakotvené v dokumentu, každý citace stránky, ze které pochází. Práce 5 stránek nebo méně návrat v řadě; větší pracovní místa se vrátí okamžitě s pending status, že jste volit do done.

• Základní URL: https://pdf.chat
• Dokumenty v: PDF, plus Word, PowerPoint, text a obrázky (PNG, JPG, WEBOP, GIF, BMP, TIFF)
• Chat mimo: odpovědi s citacemi stránek; přepisy přes historický cíl
• Zpracované znění: txt, md, docx, pdf, csv, json
• Čtecí motory: cpu (rychlé, tištěné dokumenty) a vlm (premium AI, rukopis, komplexní uspořádání, matematika)

Ověření

Ověřte si to. API žeton (najdete to na svém stránka účtu) jako hlavička:

Authorization: Bearer YOUR_API_TOKEN

Můžete také projít ?api_token=… jako parametr dotazu. Použití je odměřeno na stránce vašeho účtu.

Odeslání dokumentu

POST /api/v1/ocr/, vícedílné nahrávání formuláře.

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"

Vrací práci. Pro ≤5-stránkové soubory je již done s textem; větší soubory se vracejí pending/processing, průzkum stavový cíl.

{
  "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 } ] } ]
}

Získejte výsledek

GET /api/v1/ocr/<uuid>/, průzkum do status je done nebo failed.

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

Stáhnout formát

GET /api/v1/ocr/<uuid>/download/?format=md, exportovat výsledek. format je jedním z 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 s dokumentem

Ptejte se na hotovou práci. Odpovědi jsou uzemněny pouze ve vytaženém textu a citujte zdrojovou stránku. Vyžaduje to, že účet je uveden na účtu, funkce chat je brána na účet.

POST /api/v1/chat/<uuid>/, JSON tělo {"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?"}'

Vrací zprávu asistenta s odpovědí a seznam citovaných stránek:

{"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/, Přineste kompletní přepis konverzace pro práci.

Příklady kódů

• 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?"}'

Parametry

Omezení chyb

Každá stránka zpracovávala náklady úvěry (1/page na rychlé úrovni, více na prémie). Placené plány zvýšit per-file stránky uzávěry a přidat prioritu. Viz ceny.

Často kladené otázky