Sign in

fc5624c7d57a

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-13260150938.9 KB
Account

Request API key handoff

Builds a dashboard link that opens the create-key form prefilled with a suggested name and permissions. Requires only account:read, because it creates nothing, changes nothing, and returns no secret - the new key is issued in the owner's authenticated browser session. Use it when key management is blocked because the calling key lacks api_keys:manage, which cannot be granted through the API by the key that is missing it. Pass replaceApiKeyId to rotate; the dashboard then offers to revoke the predecessor once the replacement exists.

post/api-key-handoff

Request body

namestring

Suggested name for the new key. Trimmed to 80 characters in the link.

preset'full_access' | 'read_only' | 'agent_safe' | 'ai_drafting' | 'data_ingest_safe' | 'data_ingest_automations' | 'transactional_sender' | 'marketing_sender'

Suggested permission preset.

scopesstring[]

Suggested explicit permission scopes. Overrides preset when provided.

replaceApiKeyIdstring

ID of the key the new one replaces. Pass the literal string "current" for the key making the request.

Response

Handoff link prepared

successboolean required
messagestring
nextStepsstring[]

Example response

{
  "success": true
}