# Документация HTTP-интерфейса

Раздел описывает публичные методы API IOC Checker. Материалы разбиты по отдельным файлам для удобства сопровождения каждого маршрута.

## Общие правила

- Базовый префикс: `/api`; формат обмена — JSON в UTF-8.
- Для методов с телом запроса требуется заголовок `Content-Type: application/json`.
- Ошибки возвращаются с HTTP-статусами и полем `detail` с текстом причины без трассировок стека.
- OpenAPI доступен по путям `/api/docs` и `/api/redoc` и отражает актуальные схемы Pydantic.
- Для методов сканирования необходимо наличие токенов активных провайдеров в `secrets.toml` и их включение в `config.toml`.

## Структура файлов

- `parse_text.md` — извлечение индикаторов из текста.
- `tasks_create.md` — создание задач на сканирование индикаторов.
- `tasks_status.md` — получение статуса существующей задачи.
- `health.md` — проверка готовности API.

При изменении контрактов или требований к входным полям обновляйте соответствующий файл и ссылки на него в других разделах документации.
