Перейти к основному содержимому

Doccheck API

LLM-based API для проверки документации на соответствие требованиям ПП-87.

Аутентификация

Все запросы требуют API-ключ в заголовке X-API-Key.

X-API-Key: ваш-ключ

API-ключ выдаётся администратором. Каждый ключ видит только свои задачи.

Без ключа или с неверным ключом:

{"detail": "API key is required. Use X-API-Key header."}

HTTP-код: 401 Unauthorized

Быстрый старт

# Отправить PDF файлом
curl -X POST https://your-api/api/v1/submit \
-H "X-API-Key: ваш-ключ" \
-F "file=@document.pdf"

# Отправить по S3-ссылке
curl -X POST https://your-api/api/v1/submit-with-s3 \
-H "X-API-Key: ваш-ключ" \
-H "Content-Type: application/json" \
-d '{"document_url": "https://..."}'

# Проверить статус
curl https://your-api/api/v1/status/{task_id} \
-H "X-API-Key: ваш-ключ"

Коды ошибок

HTTP-кодОписание
202Задача ещё обрабатывается
400Некорректный запрос
401Отсутствует или неверный API-ключ
403Нет доступа (чужая задача)
404Задача не найдена
413Файл больше 500 МБ
429Превышен лимит запросов
500Внутренняя ошибка сервера