Scopes
- OpenAPI 3.1.0 document: https://api.rollstack.com/public/v1/openapi.json
- The whole reference in Markdown: https://docs.rollstack.com/llms-full.txt
- An index of the reference: https://docs.rollstack.com/llms.txt
Most endpoints need one scope, shown on their pages, and answer 403 with api-key-missing-scope when the key doesn't carry it; GET /me works with any valid key. Give a key only the scopes it needs. Some endpoints are also limited to owners and admins whatever the scope.
| Scope | Allows | Owners and admins only |
|---|---|---|
organization:read | Read the organization's settings and its LLM provider | |
organization:write | Change the organization's settings and its LLM provider | Yes |
users:read | List members and pending invites | Yes |
users:write | Change members' roles, deactivate and reactivate them, invite users and delete invites | Yes |
connections:read | List connections and their users, search their dashboards and the user's spreadsheets | |
connections:write | Create, update and delete connections, and manage their users and admins | |
credentials:write | Replace a connection's credentials | |
smtp:read | List SMTP connections | |
smtp:write | Add and delete SMTP connections | |
slide_decks:read | List folders and reports, read their content, datasheets, schedules, email settings, messages and runs, and export them | |
slide_decks:write | Create, update, delete, share and schedule reports, add their sources and upload files | |
slide_decks:run | Message the slides agent, and start and cancel runs | |
slide_decks:email | Set up and send report emails |