REST API

Документация API Pereum OCR

Интегрируйте распознавание текста в свои приложения. REST API поддерживает multipart-загрузку, JSON-ответы и токен-авторизацию.

Асинхронно

Загрузка создаёт job, результат забирается отдельным запросом.

Cookie auth

Авторизация работает через backend cookie-сессию.

Лимиты

Backend проверяет client id, fingerprint и cooldown.

Скорость

Среднее время распознавания — 1.5 секунды на страницу.

Авторизация

Bearer-токен в заголовке Authorization.

Webhook

Асинхронные результаты через webhook-колбэк.

Конечные точки

МетодПутьОписание
POST/api/recognizeРаспознавание изображения, multipart field `image`
POST/api/recognize-pdfРаспознавание PDF, multipart field `pdf`
GET/api/jobs/:idПолучение статуса и результата OCR job
GET/api/jobs/:id/searchable-pdfСкачивание searchable PDF, если backend его создал
GET/api/recognitions/historyИстория распознаваний авторизованного пользователя
POST/api/auth/registerРегистрация пользователя
POST/api/auth/loginВход и установка cookie-сессии
POST/api/auth/forgot-passwordЗапрос ссылки восстановления пароля

Примеры запросов

cURL — изображение

bash
curl -X POST https://pereum.com/api/recognize   -H "X-Client-Id: browser-client-id"   -H "X-Browser-Fingerprint: browser-fingerprint"   -F "image=@document.png"

cURL — PDF

bash
curl -X POST https://pereum.com/api/recognize-pdf   -H "X-Client-Id: browser-client-id"   -H "X-Browser-Fingerprint: browser-fingerprint"   -F "pdf=@document.pdf"

Ответ создания job

json
{
  "jobId": "c5c1c41e-3d2d-4a7f-bb79-8d2a3d2ab1db",
  "status": "queued"
}

Ответ job result

json
{
  "id": "c5c1c41e-3d2d-4a7f-bb79-8d2a3d2ab1db",
  "status": "done",
  "result": "Распознанный текст документа...",
  "error": "",
  "searchablePdfUrl": "/api/jobs/.../searchable-pdf"
}

Интеграция

  1. 1Отправьте файл в image или PDF endpoint.
  2. 2Сохраните `jobId` из ответа.
  3. 3Опрашивайте `/api/jobs/:id`, пока статус не станет `done` или `failed`.