PDF.chat API

Прагляд

API PDF.chat - гэта невялікі інтэрфейс REST. Перш за ўсё вы павінны POST дакумент, каб атрымаць яго і атрымаць заданне з тэкстам дакумента і раздзелам па старонках (тэкст, межы, давер). Затым вы можаце POST Задаць пытанні да гэтага задання і атрымаць адказы, заснаваныя на дакуменце, кожны з якіх змяшчае спасылку на старонку, з якой ён паходзіць. Заданні на 5 старонак або менш вяртаюцца ў радку; большыя задання вяртаюцца адразу з паведамленнем pending стан, які вы апытаеце да done.

• Базавы URL: https://pdf.chat
• Дакументы ў: PDF, а таксама Word, PowerPoint, тэкст і малюнкі (PNG, JPG, WEBP, GIF, BMP, TIFF)
• Chat out: адказы з цытаваннямі старонак; перапіскі праз канец гісторыі
• Выхад абпрацоўкі тэксту: txt, md, docx, pdf, csv, json
• Рухавік чытання: cpu (хуткі, друкаваны дакумент) і vlm (прэміум AI, рукапіс, складаны расклад, матэматыка)

Аўтарызацыя

Спраўджванне з дапамогай Токен API (знайсці яго на вашым камп' ютары) старонка рахунку) як загалоўка Carrier:

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 звязаная з карыстальнікам.

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

Параметры

Памылкі і абмежаванні

Кожная апрацоўка старонкі каштуе крэдыту (1/ старонка ў хуткім рэжыме, больш у прэміум- рэжыме). Плацежныя планы павышаюць абмежаванне на старонку і дадаюць прыярытэт. Глядзіце Працэнт.

Частыя пытанні