Choose permissions
New keys default to Full access, including future API groups. Restricted keys receive only their explicit grants. A restricted key with no scopes can still submit agent feedback.
Manage includes Read. Grants apply to all resources in the organization, not individual jobs. Managed workloads do not also require
data:execute; that scope controls direct data calls.
Create or change a key
Choose Full access or Restricted, save the key in your application’s secret store, and send it as a Bearer token. Changes apply to subsequent requests. Already accepted work, submitted batches, and scheduled monitors continue; stop those resources separately if needed. Renaming keys requires a paid plan. Read access includes configurations, results, history, and delivery searches. Explicit runs, mutations, delivery retries, and secret rotation require Manage. Monitor signing secrets are omitted from read-only responses. Delivery endpoints check the source’s batch or monitor permission. A missing grant returns403 INSUFFICIENT_PERMISSIONS with required_permission when identifiable. Team roles control dashboard access separately; scopes are not spending caps.
Inspect usage and retire keys
A key’s usage link opens its recent usage and request logs. The Logs API acceptskey_id with a logs:read key.
To rotate, create a replacement, update the application, verify it, then disable the old key. Disable or delete retired keys from their action menu. Removing a teammate does not erase copied shared keys; rotate those keys when offboarding.