---
title: API overview
description: The Human Plugin endpoints, how they relate, the common response rules and what the API does not provide.
canonical: https://developer.unico.io/human-plugin/api-reference/overview
locale: en
generated_by: markdown-export
---

# API overview

Three process endpoints and two health probes.

Human Plugin is served over plain HTTP on the port you configure (default `8080`). The base URL is wherever you expose the container inside your network, for example `http://human-plugin.internal:8080`.

| Method | Path | Purpose |
| --- | --- | --- |
| `POST` | `/v1/processes` | [Create a process](/human-plugin/api-reference/create-process), with one of the [flows](/human-plugin/api-reference/create-process#flows) |
| `GET` | `/v1/processes/{id}` | [Get a process](/human-plugin/api-reference/get-process) |
| `GET` | `/v1/processes/{id}/selfie` | [Get the selfie](/human-plugin/api-reference/get-selfie) |
| `GET` | `/health/live` | Liveness. See [Health and monitoring](/human-plugin/self-hosting/health-and-monitoring) |
| `GET` | `/health/ready` | Readiness (database ping) |

There is no endpoint to list, delete or search processes, and no webhook receiver.

## Rules that apply to every call

- **No authentication header.** Human Plugin does not validate callers. Restrict network access instead: see [Networking and security](/human-plugin/self-hosting/networking-and-security).
- **JSON only**, with camelCase field names.
- **Responses are `Cache-Control: no-store`.**
- **Errors** use one envelope, `{"message": "INVALID_REQUEST", "details": []}`. See [Errors and retries](/human-plugin/api-reference/errors-and-retries).
- **`id` is Human Plugin's process id.** Keep it from the create: it is how you read the process later.

## Typical sequence

```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)
```

Next: [Create a process](/human-plugin/api-reference/create-process).