Skip to main content
A Compose Key is not a provider API key. It is a signed Compose credential with an owner wallet, chain, expiry, purpose, and budget. Use API-purpose keys for external apps. Use session-purpose keys for the first-party app session flow.

Create an API key

Headers: Body:
budgetLimit uses USDC atomic units. 1000000 means 1 USDC. Response:
The API checks funding before it creates the key. If the wallet lacks USDC balance or allowance for the requested budget, the endpoint returns 402 with details.

Use a key

On each paid call, Compose validates the key, reserves budget, runs the service, prices the result, then settles the final amount.

Key purposes

Manage keys

Lists keys for x-session-user-address. The response includes budget state but not token material.
Returns one key. The bearer key must belong to the same wallet as the target key.
Revokes a key. Revocation uses signed key ownership, not an unsigned wallet header.

Budget headers