Dashboard
API Reference

API authentication

Choose the right credential for each API surface.

HALO uses separate credentials for resource spending, public project configuration, end-user authorization, and project administration. Choose by API surface instead of passing one universal token everywhere.

#Credential matrix

CredentialExampleAPI surfaces
Client API keysk-…Model Gateway, Memory
Publishable keyapikey: …Public Project Authentication
Project user accessBearer eyJ…Current user, logout, OAuth consent
OAuth App accessBearer eyJ…OAuth userinfo and service scopes
Dashboard owner JWTBearer …Project configuration and management

#HALO client key

Keys beginning with sk- authorize billable gateway and Memory calls. They must remain in a trusted runtime.

#Project publishable key

Send it in apikey orx-halo-project-key. Navigation to a provider authorize endpoint may carry ?apikey= because a browser redirect cannot add a custom header.

#Project user bearer token

The RS256 access token represents one Authentication user and one session. Verify it with the project JWKS and required claims. Do not use it as a model-spending key.

#Dashboard owner JWT

Owner routes live below /api/user. The backend verifies project ownership before allowing Authentication configuration, user administration, session revocation, API key management, or registry mutation.