Skip to main content
Manage self-serve API keys. Creating or listing keys requires an admin principal (bootstrap AGENT_CLOUD_API_KEY or a key with the admin scope). The plaintext key appears only in the create response.

Create API Key

Endpoint

Authentication

Authorization: Bearer <api_key> or Authorization: ApiKey <key> with admin scope.

Request body

string
Human label for the key (optional).
string
Tenant/user this key authenticates as. Generated (UUID) when omitted. Must be 1–64 chars of ASCII alphanumeric, _, or -.
array
Permission tokens: read, write, admin. Defaults to ["read","write"]. admin implies read and write.

Response

string
Key identifier (used for revoke).
string
Plaintext key (aria-…). Shown once, so store it now.
string
Short display prefix of the key.
string
Principal this key authenticates as.
array
Effective scope tokens.

List API Keys

Endpoint

Returns active (non-revoked) keys as a JSON array. Admin scope required. Plaintext keys are never listed.

Response

Each element:
string
Key identifier.
string
Display prefix.
string
Bound principal.
string
Optional label.
array
Scope tokens.
string
Creation timestamp from Postgres.