---
title: Обзор API
description: Эндпоинты Human Plugin, их взаимосвязь, общие правила ответов и то, чего API не предоставляет.
canonical: https://developer.unico.io/ru/human-plugin/api-reference/overview
locale: ru
generated_by: markdown-export
---

# Обзор API

Три эндпоинта процессов и две проверки состояния.

Human Plugin работает по обычному HTTP на настроенном вами порту (по умолчанию `8080`). Базовый URL — это адрес, по которому вы открываете контейнер внутри своей сети, например `http://human-plugin.internal:8080`.

| Метод | Путь | Назначение |
| --- | --- | --- |
| `POST` | `/v1/processes` | [Создание процесса](/ru/human-plugin/api-reference/create-process) с одним из [потоков](/ru/human-plugin/api-reference/create-process#flows) |
| `GET` | `/v1/processes/{id}` | [Получение процесса](/ru/human-plugin/api-reference/get-process) |
| `GET` | `/v1/processes/{id}/selfie` | [Получение селфи](/ru/human-plugin/api-reference/get-selfie) |
| `GET` | `/health/live` | Liveness. См. [Состояние и мониторинг](/ru/human-plugin/self-hosting/health-and-monitoring) |
| `GET` | `/health/ready` | Readiness (проверка базы данных) |

Эндпоинтов для просмотра списка, удаления или поиска процессов нет, как нет и приёмника вебхуков.

## Правила, которые действуют для каждого вызова

- **Заголовка аутентификации нет.** Human Plugin не проверяет вызывающих. Вместо этого ограничьте сетевой доступ: см. [Сеть и безопасность](/ru/human-plugin/self-hosting/networking-and-security).
- **Только JSON**, имена полей в camelCase.
- **Ответы отправляются с `Cache-Control: no-store`.**
- **Ошибки** имеют единый формат: `{"message": "INVALID_REQUEST", "details": []}`. См. [Ошибки и повторные попытки](/ru/human-plugin/api-reference/errors-and-retries).
- **`id` — это id процесса в Human Plugin.** Сохраните его при создании: по нему вы позже прочитаете процесс.

## Типичная последовательность

```mermaid
sequenceDiagram
  participant B as Your back-end
  participant H as Human Plugin
  B->>H: POST /v1/processes
  H-->>B: 201 + id, state, data
  B->>H: GET /v1/processes/{id}
  H-->>B: 200 + id, state, data (humanToken, ndocs)
```

Далее: [Создание процесса](/ru/human-plugin/api-reference/create-process).