Scope reference
Understand what each Personal Access Token scope allows.
Scopes limit what a token can do. Pick the smallest set that lets your client work.
Available scopes#
| Scope label | Use |
|---|---|
| Read your profile | Read basic user profile data. |
| Read your subscription | Inspect plan/quota information. |
| Read available models | List models the workspace can use. |
| Read bots & documents | List/read bots and document metadata. |
| Create, update, delete bots | Manage bots and documents. |
| Read API conversations | Read conversations created for API usage. |
| Create, delete API conversations | Create or remove API conversations. |
| Send chat messages | Send messages to bots. |
| Read usage analytics | Read usage reports. |
Preset mapping#
- Chat API only: conversations and messages needed for chat.
- Read-only: profile/subscription/models/bots/usage read scopes.
- Bot management: bot read/write plus supporting read scopes.
Changing scopes#
Scopes cannot be edited after token creation. Revoke the token and create a new one.