Developer documentation
Scope reference
Granular scopes map to backend permissions. Request only the scopes your integration needs.
How scopes work
At key creation, requested scopes are intersected with the creator's role permissions. Routes enforce scopes independently.
- Studio-licensed project required for API usage
- Schedule and budget AI reruns require Studio scopes
- Activity logs record api_key_used events for mutating calls
Scope reference
Projects
| Scope | Description |
|---|---|
| projects:read | List and read project metadata |
| projects:create | Create projects in the workspace |
| projects:update | Update project settings |
| projects:archive | Archive projects |
| projects:delete | Delete projects |
| projects:export | Export project deliverables |
Screenplay & breakdown
| Scope | Description |
|---|---|
| screenplay:upload | Upload screenplay versions |
| screenplay:edit | Edit screenplay content |
| screenplay:lock | Lock or unlock production scripts |
| screenplay:breakdown | Manage breakdown tags and elements |
| screenplay:share_links | Create and manage share links |
| breakdown:rerun | Rerun AI breakdown |
Scheduling
| Scope | Description |
|---|---|
| scheduling:read | Read schedules and stripboards |
| scheduling:edit | Edit schedule data |
| scheduling:rerun | Rerun AI schedule generation (Studio) |
Budgeting
| Scope | Description |
|---|---|
| budgeting:read | Read budget topsheets and line items |
| budgeting:edit | Edit budget data |
| budgeting:rerun | Rerun AI budget analysis (Studio) |
Coverage
| Scope | Description |
|---|---|
| coverage:read | Read coverage reports |
| coverage:edit | Edit coverage content |
| coverage:rerun | Rerun AI coverage |
Workspace
| Scope | Description |
|---|---|
| workspace:read | Read workspace metadata |
| workspace:members:read | List workspace members |
| workspace:activity:read | Read workspace activity logs |