Browse documentation
All 22 scopes, dependencies, and beta write permissions.
Deny-by-default: a scope not in this registry cannot be granted, and a route or tool cannot be registered without one. When creating or updating a key, every scope's Requires list must also be present on the key (422 validation_failed, param: "scopes"). Beta scopes additionally need the owner's enrollment to allow them, both at key creation and on every request.
Scope | Category | Beta | Requires | Grants |
|---|---|---|---|---|
| read | — | List/read bound brands and capabilities | |
| read |
| Prompt library and metrics | |
| read |
| Scan runs and visibility metrics | |
| read |
| Recommendations | |
| read |
| Generated content metadata and bodies | |
| read |
| Sanitized integration status and capabilities | |
| read | — | Read and cancel jobs | |
| read |
| Current Calendar page | |
| read |
| Current Results page | |
| read |
| Website overview, inventory, changes, activity | |
| read |
| Local locations, runs, observations, recommendations | |
| read |
| Image bank | |
| read | — | Account/key API usage and limits | |
| write | ✓ |
| Start generation jobs |
| write | ✓ |
| Publication previews (no external effect) |
| external | ✓ |
| Publish to destinations. Can only be granted while |
| write | ✓ |
| Edit calendar topics, cancel/reschedule schedules |
| write | ✓ |
| Edit drafts, select cover image |
| write | ✓ |
| Refresh social performance metrics |
| external | ✓ |
| Website publish/recheck/undo/mode |
| write | ✓ |
| Locations, Local recommendation status, Local runs |
| admin | — | Manage the owner's keys; also reads usage |
Removing a scope from a cohort's enrollment removes it from the effective scopes of existing keys within ~10–30 s; the stored key is not edited.