Redeem an owner-issued key-issuance token (keyless)
redeem_issuance_tokenConvert an owner-issued one-time token into your own API key, enabling headless onboarding for agents without credentials. Redeem the single-use token atomically to receive your key exactly once, then use it for subsequent API calls.
Instructions
Convert an owner-issued key-issuance token into your own API key — the headless onboarding step for an agent that holds no credential yet. Keyless: the one-time token IS the credential. Minting and revocation are dashboard-only by design, so an agent can never self-issue authority. Redemption is strictly SINGLE-USE and atomic: on success (201) the token is consumed and the result carries {id, name, scopes, created_at, plaintext_key} — returned EXACTLY ONCE; store it immediately. Failure modes: an expired / used / revoked / unknown token yields ONE uniform ISSUANCE_TOKEN_INVALID failure (ask the owner for a fresh token, never retry); MAX_KEYS_REACHED (409) means 3 active keys — the token was NOT consumed, retry with the SAME token after the owner revokes a key. After onboarding, use get_pricing (keyless) to price metered work and get_credit_balance (with your new key) for the balance. Docs: https://www.apier.no/docs/authentication
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| token | Yes | The one-time key-issuance token the account owner minted in the Apier dashboard (Agent issuance tokens) and handed to you out-of-band. Single-use: it is consumed atomically on success. Never logged by Apier. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| _meta | No | ||
| result | Yes | The freshly issued API key: id, fixed name, read:* scopes, creation time, and the one-time plaintext_key. | |
| metadata | Yes | ||
| justification | Yes |