Обзор API
Три эндпоинта процессов и две проверки состояния.
Human Plugin работает по обычному HTTP на настроенном вами порту (по умолчанию 8080). Базовый URL — это адрес, по которому вы открываете контейнер внутри своей сети, например http://human-plugin.internal:8080.
| Метод | Путь | Назначение |
|---|---|---|
POST | /v1/processes | Создание процесса с одним из потоков |
GET | /v1/processes/{id} | Получение процесса |
GET | /v1/processes/{id}/selfie | Получение селфи |
GET | /health/live | Liveness. См. Состояние и мониторинг |
GET | /health/ready | Readiness (проверка базы данных) |
Эндпоинтов для просмотра списка, удаления или поиска процессов нет, как нет и приёмника вебхуков.
Правила, которые действуют для каждого вызова
- Заголовка аутентификации нет. Human Plugin не проверяет вызывающих. Вместо этого ограничьте сетевой доступ: см. Сеть и безопасность.
- Только JSON, имена полей в camelCase.
- Ответы отправляются с
Cache-Control: no-store. - Ошибки имеют единый формат:
{"message": "INVALID_REQUEST", "details": []}. См. Ошибки и повторные попытки. id— это id процесса в Human Plugin. Сохраните его при создании: по нему вы позже прочитаете процесс.
Типичная последовательность
Далее: Создание процесса.