---
title: API 概览
description: Human Plugin 的各个端点、它们之间的关系、通用的响应规则，以及该 API 不提供的功能。
canonical: https://developer.unico.io/zh-CN/human-plugin/api-reference/overview
locale: zh-CN
generated_by: markdown-export
---

# API 概览

三个流程端点和两个健康探针。

Human Plugin 通过您所配置的端口（默认 `8080`）以纯 HTTP 提供服务。基础 URL 取决于您在网络内部暴露容器的位置，例如 `http://human-plugin.internal:8080`。

| 方法 | 路径 | 用途 |
| --- | --- | --- |
| `POST` | `/v1/processes` | [创建流程](/zh-CN/human-plugin/api-reference/create-process)，使用其中一种[流程类型](/zh-CN/human-plugin/api-reference/create-process#flows) |
| `GET` | `/v1/processes/{id}` | [获取流程](/zh-CN/human-plugin/api-reference/get-process) |
| `GET` | `/v1/processes/{id}/selfie` | [获取自拍照](/zh-CN/human-plugin/api-reference/get-selfie) |
| `GET` | `/health/live` | 存活探针。参见[健康检查与监控](/zh-CN/human-plugin/self-hosting/health-and-monitoring) |
| `GET` | `/health/ready` | 就绪探针（数据库 ping） |

没有用于列出、删除或搜索流程的端点，也没有 webhook 接收器。

## 适用于每次调用的规则

- **没有认证头。** Human Plugin 不会验证调用方。请改为限制网络访问：参见[网络与安全](/zh-CN/human-plugin/self-hosting/networking-and-security)。
- **仅支持 JSON**，字段名使用 camelCase。
- **响应带有 `Cache-Control: no-store`。**
- **错误**使用统一的信封格式 `{"message": "INVALID_REQUEST", "details": []}`。参见[错误与重试](/zh-CN/human-plugin/api-reference/errors-and-retries)。
- **`id` 是 Human Plugin 的流程 id。** 请在创建时保存它：之后读取该流程要靠它。

## 典型流程

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

下一步：[创建流程](/zh-CN/human-plugin/api-reference/create-process)。