llmocrapi.comГайд
Документация по OCR API: эндпоинты, режимы и лимиты
Эта страница служит документацией по OCR API для разработчиков, которым нужна вся функциональность в одном месте: два эндпоинта, четыре режима запросов, лимиты и ошибки. API очищает текст, который уже сгенерировал OCR-движок; он не обрабатывает изображения.
Обновлено

Ключевые моменты
- Существует два метода: POST /v1/chat/completions и GET /v1/models, аутентификация с помощью Bearer-ключа.
- Потоковая передача, JSON-режим и вызов функций следуют формату чата OpenAI с идентификатором модели uncensored.
- Лимиты: 8 параллельных запросов и 300 в минуту для полного ключа, 2 и 60 для пробного ключа, тело запроса до 8 МБ.
- Ошибки при перегрузке — HTTP 429 с кодом, указывающим, следует ли снизить скорость или уменьшить параллелизм.
Обзор и аутентификация
Сервис — это размещённый API текста, совместимый с OpenAI. Его задача на этом сайте — вторая часть работы OCR: взять сырую строку, полученную OCR-движком, и вернуть чистый текст, структурированные поля или отмеченные строки. На вход подаётся только текст. Нет ввода или вывода изображений, аудио или видео, нет эмбеддингов и нет дообучения.
Всё работает через один базовый URL, https://api.llmocrapi.com/v1. Аутентификация — стандартный заголовок Bearer: Authorization: Bearer YOUR_KEY. Вы создаёте ключ на странице API-ключ после входа через Google или с помощью электронной почты и пароля. Модель за эндпоинтом — одна модель с открытыми весами от независимого провайдера. Это не официальный API вендора моделей и не роутер между вендорами. Её ID всегда uncensored.
Для практического руководства вместо справочника в разделе документации шаг за шагом описан первый запрос.
Эндпоинты вкратце
| Метод и путь | Назначение |
|---|---|
GET /v1/models | Список доступных моделей. Используйте его для дешёвой проверки ключа. |
POST /v1/chat/completions | Запускает модель на списке сообщений. Поддерживает потоковую передачу, JSON-режим и инструменты. |
Это вся функциональность. Поскольку она соответствует формату передачи данных OpenAI, любая клиентская библиотека, позволяющая установить базовый URL и ключ, будет работать. Быстрая проверка работоспособности:
curl https://api.llmocrapi.com/v1/models \
-H "Authorization: Bearer $LLMOCR_API_KEY"
Действительный ключ возвращает список моделей, содержащий uncensored. Неверный ключ возвращает ошибку аутентификации, что указывает на проблему с ключом, а не с телом запроса.
Параметры запроса
Запрос chat completion требует model и messages. Дополнительные поля ниже передаются модели.
temperatureиtop_p: элементы управления сэмплированием. Для восстановления OCR используйтеtemperature0, чтобы идентичный ввод давал идентичный вывод.max_tokens: необязательно. Если вы его не укажете, завершение может использовать все оставшееся место в 100 000-токенном окне после вашего промпта. Установите его, когда хотите жесткий лимит стоимости за вызов.stop: строки, которые завершают генерацию. Удобно, когда вы запрашиваете вывод между маркерами.seed: улучшает воспроизводимость между запусками.presence_penaltyиfrequency_penalty: передаются. Оставьте их равными нулю для очистки, так как штрафы могут заставить модель изменить повторяющиеся законные слова, такие как заголовки таблиц.stream,response_format,toolsиtool_choice: описаны в следующих трех разделах.
Контекстное окно учитывает промпт и завершение вместе в 100 000 токенов, а тело запроса может быть до 8 МБ. На практике лимит токенов достигается первым.
Потоковые ответы
Установите "stream": true, и API отправляет Server-Sent Events, по мере генерации текста. Потоковая передача помогает интерактивным инструментам, таким как редактор, где человек видит, как появляется очищенный абзац. Использование токенов сообщается в конце потока, поэтому вы все еще можете записать стоимость.
import os
from openai import OpenAI
client = OpenAI(base_url="https://api.llmocrapi.com/v1", api_key=os.environ["LLMOCR_API_KEY"])
stream = client.chat.completions.create(
model="uncensored",
stream=True,
messages=[{"role": "user", "content": "Fix this OCR text: th1s is a sam-\nple."}],
)
for chunk in stream:
if chunk.choices and chunk.choices[0].delta.content:
print(chunk.choices[0].delta.content, end="", flush=True)
if getattr(chunk, "usage", None):
print("\ntokens:", chunk.usage.prompt_tokens, chunk.usage.completion_tokens)
Одна деталь влияет на пропускную способность. Запрос в потоковом режиме занимает слот параллелизма до конца потока. Если ваш код прекращает чтение посередине и оставляет соединение открытым, этот слот остается занятым. Явно закройте поток или прочитайте его до конца.
JSON-режим
JSON-режим просит модель ответить объектом JSON, а не текстом. Включите его с помощью response_format и опишите ключи в своих инструкциях.
{
"model": "uncensored",
"temperature": 0,
"response_format": {"type": "json_object"},
"messages": [
{"role": "system", "content": "Return JSON with keys 'text' (cleaned string) and 'uncertain_lines' (array of integers)."},
{"role": "user", "content": "line one\nl1ne two\nline thr3e"}
]
}
Парсите с осторожностью. JSON-режим формирует вывод, но всё равно следует проверять ключи и типы перед тем, как они попадут в базу данных. Если ответ был обрезан из-за max_tokens, JSON может быть неполным, поэтому поднимите лимит или отправляйте меньшие части.
Вызов функций
Вызов функций позволяет модели попросить ваш код что-то сделать вместо написания текста. Для задач OCR распространённый сценарий — возврат структурированных исправлений: модель вызывает функцию с номером строки и заменой, а ваш код применяет её. Определите инструменты в массиве tools, выберите поведение с помощью tool_choice и верните результаты как сообщения с role: "tool". При потоковой передаче вызовы инструментов поступают постепенно как дельты tool_calls.
tools = [{
"type": "function",
"function": {
"name": "replace_line",
"description": "Replace one line of the OCR text with a corrected version.",
"parameters": {
"type": "object",
"properties": {
"line": {"type": "integer"},
"text": {"type": "string"},
},
"required": ["line", "text"],
},
},
}]
resp = client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "1: The inven-\n2: tory was com1leted."}],
tools=tools,
tool_choice="auto",
)
for call in resp.choices[0].message.tool_calls or []:
print(call.function.name, call.function.arguments)
Аргументы возвращаются в виде строки JSON. Разберите их, примените изменение и, если вы продолжаете диалог, добавьте сообщение ассистента с role: "tool" и соответствующим tool_call_id. Этот шаблон сохраняет количество выходных токенов на низком уровне, так как модель возвращает только изменённые строки.
Настройки для очистки текста
Справочник более полезен с рекомендуемой начальной точкой, поэтому вот как параметры обычно комбинируются для восстановления OCR. Это предложения, основанные на поведении задачи, а не измеренные бенчмарки.
- Детерминированное восстановление:
temperature0, без штрафов, фиксированныйseed. Используйте это для архивов, где вы хотите, чтобы повторный запуск воспроизвел вчерашний вывод. - Извлечение полей:
temperature0,response_formatустановлен вjson_objectи установлен лимитmax_tokensнемного выше самого большого объекта, который вы ожидаете. - Интерактивная проверка:
streamtrue и короткий системный промпт, чтобы редактор видел появляющийся исправленный текст и мог остановить его досрочно. - Исправления на уровне строк: инструменты с функцией стиля
replace_line, чтобы модель возвращала только то, что изменилось.
Роли сообщений следуют обычному соглашению: system для постоянных инструкций, user для текста OCR, assistant для предыдущих ответов в многошаговом диалоге и tool для результатов функций. Поместите инструкции в системное сообщение, а сырой текст — в сообщение пользователя. Если сам текст OCR содержит что-то, похожее на инструкцию, например, отсканированный знак с указанием игнорировать предыдущий текст, разделение упрощает объяснение модели, что сообщение пользователя — это данные для исправления, а не команда к выполнению. Скажите об этом явно в системном промпте.
Сохраняйте значение X-Request-Id для каждого вызова. Это идентификатор, в котором нуждается поддержка, если одна страница вернулась неверно и вы хотите, чтобы её проверили.
Лимиты, заголовки и ошибки
| Лимит | Полный ключ | Пробный ключ |
|---|---|---|
| Параллельные запросы | 8 | 2 |
| Запросов в минуту | 300 | 60 |
| Максимальный размер тела | 8 МБ | 8 МБ |
| Контекстное окно | 100 000 токенов | 100 000 токенов |
Ответы включают X-Request-Id (сообщайте его поддержке), X-Balance-USD (ваш оставшийся баланс), X-RateLimit-Limit-Requests и X-RateLimit-Limit-Concurrency.
Когда вы превышаете лимит, API отвечает HTTP 429. Код ошибки rate_limited означает слишком много запросов в минуту, поэтому распределите нагрузку. Код concurrency означает слишком много одновременных запросов, поэтому снизьте количество воркеров. 429 с заголовком Retry-After: 5 сигнализирует о временной перегрузке: подождите пять секунд и отправьте снова. Неудачные и отклонённые запросы не тарифицируются, поэтому цикл повторных попыток безопасен.
Оплата идёт за токен: $0,15 за 1M входных и $0,50 за 1M выходных, списывается с предоплаченного баланса, срок действия которого не истекает. См. страницу тарифов для сумм пополнения и бонусов. Промпты не используются для обучения. Правило контента — один жёсткий лимит: нет сексуального контента с участием несовершеннолетних. Вопросы о правилах — в поддержку.
Дополнительные руководства
Вопросы и ответы
Какие эндпоинты предоставляет API?
Два: POST /v1/chat/completions для генерации и GET /v1/models для списка моделей. Оба используют один и тот же Bearer-ключ.
Поддерживает ли он потоковую передачу и вызов функций?
Да. Установите stream в true для SSE с данными об использовании в конце и используйте tools и tool_choice для вызовов функций, возвращая результаты как сообщения role tool.
Каков максимальный размер входных данных?
Контекстное окно составляет 100 000 токенов для промпта плюс завершение, а тело запроса может быть до 8 МБ.
Почему я получил ошибку 429?
Вы превысили лимит запросов в минуту (rate_limited), лимит параллельных запросов (concurrency) или столкнулись с временной перегрузкой, которая включает Retry-After: 5. Подождите и повторите попытку.
До вашего ключа — всего одна форма
Создайте аккаунт, скопируйте ключ, измените базовый URL. Это вся настройка.