ダッシュボード
API リファレンス

API 認証

各 API サーフェスに適切な認証情報を選択してください。

HALO は、リソースの支出、パブリック プロジェクトの構成、エンドユーザーの承認、プロジェクト管理に個別の認証情報を使用します。 1 つのユニバーサル トークンをどこにでも渡すのではなく、API サーフェスによって選択します。

#認証情報マトリックス

認証情報例API サーフェス
Project secret API keysk-…Model Gateway, Memory, and Agent Access partner /projects routes; trusted backend only
プロジェクト公開可能キーapikey: halo_pk_…Project Authentication signup, login, and public configuration
Project user JWTapikey + Bearer eyJ…Project Authentication current user/logout; bearer-only Identity OAuth consent; project_auth end-user proof in an Agent Access Link request
Identity OAuth Client accessBearer eyJ…Project OAuth userinfo and approved identity scopes
HALO platform owner JWTBearer …Project administration and the signed-in owner's Access Identity verification, consent, approvals, and revocation

#Project secret API key

次で始まるキー sk- authorize billable gateway and Memory calls. Agent Access partner routes under/api/v1/agent-access/projects/:projectKey accept the matching Project key in Authorization: Bearer sk-… またはx-api-key. Keep these keys in your backend; the user's browser opens the returned Link URL instead.

#プロジェクト公開可能キー

送信 apikey またはx-halo-project-keyを受信できるように、その正確な URL に移動します。プロバイダー承認エンドポイントへのナビゲーションには ?apikey= because a browser redirect cannot add a custom header. The key is public application identity, equivalent to a Supabase publishable key; it is not a client secret.

#プロジェクト ユーザー ベアラー トークン

The RS256 access token represents one Authentication user and one session. Current-user and logout calls must include both this bearer token and the matching Project publishable key. Verify it with the project JWKS and required claims. A backend using HALO Project Authentication may pass this token as endUser.accessTokenwith endUser.type: "project_auth"when creating an Agent Access Link Session. It identifies the application's user; it does not authorize that user's external accounts or replace the HALO platform JWT used for Access Identity consent.

#HALO platform owner JWT

HALO platform sign-in issues this token separately from Project Authentication signup and login. Owner administration routes live below /api/user. The backend verifies project ownership before allowing Authentication configuration, user administration, session revocation, API key management, or registry mutation. Access Identity routes under/api/v1/agent-accessuse the signed-in HALO owner's token to verify their identity, record consent, approve executions, and revoke access.

See the Agent Access integrationfor the partner-to-user handoff andconsent-based same-email linkingfor optional external-user association. Application signup and Identity OAuth consent do not create Agent Tool grants.