---
title: API の概要
description: Human Plugin のエンドポイントとその関係、共通のレスポンスルール、API が提供しないものについて説明します。
canonical: https://developer.unico.io/ja/human-plugin/api-reference/overview
locale: ja
generated_by: markdown-export
---

# API の概要

3 つのプロセスエンドポイントと 2 つのヘルスプローブ。

Human Plugin は、設定したポート (デフォルトは `8080`) でプレーンな HTTP として提供されます。ベース URL は、ネットワーク内でコンテナを公開した場所です。たとえば `http://human-plugin.internal:8080` です。

| メソッド | パス | 目的 |
| --- | --- | --- |
| `POST` | `/v1/processes` | いずれかの[フロー](/ja/human-plugin/api-reference/create-process#flows)で[プロセスを作成](/ja/human-plugin/api-reference/create-process)します |
| `GET` | `/v1/processes/{id}` | [プロセスを取得](/ja/human-plugin/api-reference/get-process)します |
| `GET` | `/v1/processes/{id}/selfie` | [セルフィーを取得](/ja/human-plugin/api-reference/get-selfie)します |
| `GET` | `/health/live` | ライブネス。[ヘルスとモニタリング](/ja/human-plugin/self-hosting/health-and-monitoring)を参照してください |
| `GET` | `/health/ready` | レディネス (データベースへの ping) |

プロセスの一覧表示、削除、検索を行うエンドポイントはなく、Webhook レシーバーもありません。

## すべての呼び出しに適用されるルール

- **認証ヘッダーはありません。** Human Plugin は呼び出し元を検証しません。代わりにネットワークアクセスを制限してください。[ネットワークとセキュリティ](/ja/human-plugin/self-hosting/networking-and-security)を参照してください。
- **JSON のみ**で、フィールド名は camelCase です。
- **レスポンスは `Cache-Control: no-store`** です。
- **エラー**は単一のエンベロープ `{"message": "INVALID_REQUEST", "details": []}` を使用します。[エラーと再試行](/ja/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)
```

次へ: [プロセスの作成](/ja/human-plugin/api-reference/create-process)。