Entity Enricherへのプログラムによるアクセス用にAPI keyを作成します。サービス間連携、CI/CDパイプライン、自動化ワークフローにはorganizationアクセスキーをご利用ください。
Entity Enricher は 2 種類の API キーをサポートしており、それぞれ異なるユースケースに適しています。
どのユーザーアカウントにも紐づかず、独自のロールを持つスタンドアロンのキーです。サービス間連携に最適です。
特定のユーザーアカウントに紐付けられたキーです。作成者のロールを継承し、ユーザーアカウントの変更の影響を受けます。
ent_a1b2c3d4e5f6g7h8キーは ent_ プレフィックスの後にランダムなバイト列が続きます。完全なキーは作成時に一度だけ表示され、後から取得することはできません。
アクセスキー（Entity Enricher の API を呼び出すためのもの）はデータベースに SHA256 ハッシュとして保存されるため、データベースにアクセスできても元のキーを復元することはできません。識別のため、最初の 12 文字（プレフィックス）のみが平文で保存されます。
プロバイダーキー（Anthropic や OpenAI などの LLM API キー）は、Fernet 対称暗号（AES-128-CBC + HMAC）を使用して保存時に暗号化されます。LLM プロバイダーとの認証のため、実行時に復号可能である必要があります。プレーンテキストで保存されるのは末尾の4文字のみです。
キーはアプリケーションのAPI Keysページから、またはREST APIを使ってプログラムから作成します:
| フィールド | 説明 |
|---|---|
| 名前 | 識別用のわかりやすい名前（例：「CI/CD Pipeline」「n8n Integration」） |
| ロール | 権限レベル：オーナー、エディター、またはオペレーター。キーがアクセスできる範囲を決定します。 |
| スコープ | 読み取り、書き込み、またはその両方。キーがデータを変更できるか、読み取りのみできるかを制御します。 |
| 有効期限 | 任意の有効期限。有効期限のないキーは取り消されるまで有効です。 |
すべてのリクエストで X-API-Key ヘッダーに API キーを含めて送信してください:
curl -H "X-API-Key: ent_your_key_here" \
https://your-instance.example.com/api/enrichment/options| メソッド | ヘッダー | ユースケース |
|---|---|---|
| APIキー | X-API-Key: ent_... | サービス間連携、CI/CD、自動化 |
| Bearer トークン | Authorization: Bearer <jwt> | Web クライアント、対話型セッション |
APIキーのロールによって、アクセスできるエンドポイントが決まります:
| エンドポイントのカテゴリ | 最小ロール |
|---|---|
| エンリッチメント（単一、バッチ） | 演算子 |
| レコード（一覧、詳細、削除） | 演算子 |
| スキーマ（読み取り） | 演算子 |
| スキーマ（作成、編集、削除） | エディター |
| フュージョン | 演算子 |
| プロバイダー情報 | 演算子 |
| コスト分析 | 演算子 |
| APIキー管理 | オーナー |
| ユーザー管理 | オーナー |
APIキーページでは、すべての組織キーを使用統計とともに一覧で確認できます:
APIキーページには、それぞれ異なる目的を持つ複数のタブがあります:
独立した課金のための organization の LLM provider API キー（Anthropic、OpenAI など）。provider ごとに複数のキーをサポートし、自動 LRU ローテーションを行います。BYOK システムについては Models & Pricing をご覧ください。
プロバイダーキーはFernet対称暗号化(HMAC認証付きAES-128-CBC)を使用して保存時に暗号化されます。LLM API呼び出しを行う実行時にのみ復号されます。表示目的で平文として保存されるのは末尾の4文字のみです。
管理者が管理するシステム全体の LLM provider キーです。organization のキーが利用できない場合のフォールバックとして使用されます。provider ごとの複数キーに対応し、LRU ローテーションと恒久的な障害発生時の自動無効化を備えています。
Entity Enricher自身のAPIにアクセスするためのキーです。外部システムがエンリッチメント、スキーマ、レコード、その他のエンドポイントをプログラムから呼び出す際に使用します。エンドポイントのドキュメントについてはAPI Referenceをご覧ください。