API の概要
3 つのプロセスエンドポイントと 2 つのヘルスプローブ。
Human Plugin は、設定したポート (デフォルトは 8080) でプレーンな HTTP として提供されます。ベース URL は、ネットワーク内でコンテナを公開した場所です。たとえば http://human-plugin.internal:8080 です。
| メソッド | パス | 目的 |
|---|---|---|
POST | /v1/processes | いずれかのフローでプロセスを作成します |
GET | /v1/processes/{id} | プロセスを取得します |
GET | /v1/processes/{id}/selfie | セルフィーを取得します |
GET | /health/live | ライブネス。ヘルスとモニタリングを参照してください |
GET | /health/ready | レディネス (データベースへの ping) |
プロセスの一覧表示、削除、検索を行うエンドポイントはなく、Webhook レシーバーもありません。
すべての呼び出しに適用されるルール
- 認証ヘッダーはありません。 Human Plugin は呼び出し元を検証しません。代わりにネットワークアクセスを制限してください。ネットワークとセキュリティを参照してください。
- JSON のみで、フィールド名は camelCase です。
- レスポンスは
Cache-Control: no-storeです。 - エラーは単一のエンベロープ
{"message": "INVALID_REQUEST", "details": []}を使用します。エラーと再試行を参照してください。 idは Human Plugin のプロセス id です。 作成時に保管してください。後でプロセスを読み取る際に使います。
典型的なシーケンス
次へ: プロセスの作成。