PDF.chat API

Напиши PDF и chat со него од твојата апликација — поставувај прашања и добивај одговори наведени на страницата, на 100+ јазици.

Преглед

PDF.chat API е мал РЕСТ интерфејс. Прво вие POST документ за да го попиете и да си најдете работа со текстот на документот и скршеност на страница (текст, гранични кутии, самодоверба). Потоа вие POST Прашања против таа работа и добивање на одговорите на документот, секоја од нив ја наведува страницата од која доаѓа. pending статусот што го истражувате до done.

  • Основен URL: https://pdf.chat
  • Документи во: PDF, плус Word, PowerPoint, текст и слики (PNG, JPG, WEBP, GIF, BMP, TIFF)
  • Chat надвор: одговори со страници на цитатите; транскрипти преку крајниот крај
  • Обработен текст: txt, md, docx, pdf, csv, json
  • Читање на моторите: cpu (брзи, печатени доц) и vlm (премиум АИ, ракопис, сложен распоред, математика)

Автентификација

Автентифицирај се со твојот API- знак (Најде на твојата страница на сметката) како заглавје на носачот:

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"

Ја враќа задачата. За датотеките ≤5- страници веќе е 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

Chat со документ

Поставувајте прашања за завршена задача. Одговорите се запишани само во превземениот текст и ја цитираат изворната страница. Потребува жетон за сметка, функцијата chat е извршена од сметката.

POST /api/v1/chat/<uuid>/, Телото на ЈСОН {"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/, Донеси го целиот препис на разговорот за работа.

Примери за код

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

Параметри

ПолеТипОпис
filefileПотребен е. Сликата или PDF за процес.
tierstringcpu (стандардно, брзо/ отпечатено) или vlm Премиум АИ: ракопис, распоред, математика.
languagestringauto (стандардно) или код на јазик (en, ch, ja, ar,...).
toolstringОпционо алатка (на пример summarize-pdf, ask-pdf) да ги предрасположи chat за таа задача.

Грешка и ограничувања

КодЗначење
400Нема датотека, неподдржан тип или датотека преголема.
401Недостасува или невалиден API- знак.
402Од страници, секој месец без граници, или без кредити. used/cap.
404УУИД не е пронајден.
409Симнувањето е побарано пред завршувањето на задачата.

Секоја страница ги обработува кредитите за трошоци (1/страница на брзиот ступенј, повеќе на премиум). Платените планови ги зголемуваат капаците на страниците по датотеки и додаваат приоритет. Види цени.

Често поставувани прашања

Креирај бесплатна сметка и отвори ја твојата страница на сметката, вашиот жетон е прикажан таму со копче за копирање.

Да, датотеките од 5 страници или помалку ја враќаат целата резултатна линија во одговорот на POST, така што не е потребно анкетирање за повеќето слики и кратки PDF-ови.

Повеќе од 100, вклучувајќи ги и латинските, CJK, арапски, кирилициндијански скрипти. language=auto Да откриеш или да предадеш специфичен код.

Препраќањето се обработува само за да одговори на вашите прашања и автоматски да го избришеме.

Употребата е измерена на страница во однос на вашата сметка: анонимните повици добиваат дневен дневник за ИП, бесплатни сметки за месечна кофа и платени планови за користење на купени кредити со повисоки капаци и приоритет на страницата на датотеката. Кога ќе завршите, добивате 402 со користено и капаче во телото.

Може да испратите PNG, JPG, WEBP, GIF, BMP, TIFF и повеќестранично PDF. Превземање на резултати како txt, md, docx, pdf (тражебно), csv или json преку параметарот на формат на крајниот крајен крај.

400 е недостасувачка датотека, тип на кој не се поддржува, или датотека преголема; 401 недостасува или невалиден жетон; 402 од страници; 404 непозната задача UUID; и 409 симнување барано пред завршувањето на задачата. Телата на грешки вклучуваат кратка порака.

Објекат со статус, ступења, јазик, page_ count и средна_ самодоверба, плус целосниот текст и маркирање. Низата на страници ја крши секоја страница на блокови со нивниот текст, граничиво поле (bbox) и самодоверба по блокови.

Користете cpu (стандардно) за брзо, ниско трошочно препознавање на чисти печатени документи. Користете vlm, премиум AL енџин, за ракопис, комплексни или повеќе колонски распореди, математика и превод, каде што е многу поточно.

Алатка за пренесување со куршум (на пример резим-pdf или запрашање-pdf) за предрамење на chat за таа задача, па затоа помошникот е наместен да ги резимира или одговара на прашањата за документот.

Датотеките од 5 страници или помалку враќање во одговорот на POST. Поголеми датотеки се враќаат веднаш како што се очекува или се обработува, и вие избирате GET / api/ v1/ okr/<uuid>/ додека не биде направен или неуспешен статусот. Платените планови го зголемуваат капакот на страницата по датотека.

API е обичен REST преку HTTPS, па така работи од било кој јазик со HTTP клиент, гледајте ги Python, Node.js и cURL примерите горе. Нема SDK за инсталирање; неколку редови од стандарден HTTP код се се сите што ви требаат.