Permissions
What a request can do depends on two things: the scopes of your API key or app connection, and your roles in the workspace and project.
Scopes
Each endpoint's reference page shows the scope it needs. A key or connection can call only the endpoints its scopes allow. With no scopes, it can call only Ping.
| Scope | Allows |
|---|---|
projects:read | Searching and reading projects, and listing archived projects and projects scheduled for deletion |
projects:write | Creating, updating, archiving, and unarchiving projects, and scheduling or canceling their deletion |
folders:read | Listing and reading folders |
folders:write | Creating, updating, and deleting folders |
files:read | Listing and reading files, and checking the AI jobs of generated files |
files:write | Uploading, updating, tagging, and deleting files |
files:download | Getting file download URLs |
ai:generate | Listing AI models, estimating and generating files with AI, and uploading generation attachments |
comments:read | Listing and reading comments, replies, and reactions |
comments:write | Creating, updating, and deleting comments, reactions, and comment attachments |
comments:download | Getting comment attachment download URLs |
workspace-members:read | Listing workspace members |
project-members:read | Listing project members |
project-members:write | Adding, updating, and removing project members |
access-links:read | Listing and reading access links |
access-links:write | Creating, updating, and deleting access links |
access-links:read.key | Seeing the accessKey of access links. Without it, accessKey is null |
skills:read | Listing and reading skills, and downloading skill versions |
skills:write | Creating, updating, and deleting skills, and creating or deleting skill versions |
schedules:read | Listing and reading project schedules |
schedules:write | Creating, updating, and deleting project schedules |
usage:read | Reading workspace usage. With credits:read, the response also includes credits |
credits:read | Listing plan credits, purchased credits, and member credits. With usage:read, workspace usage also includes credits |
Roles
Requests act as you, so you can reach the same projects you can open in the YouViCo app:
- Projects you have joined
- Projects open to the whole workspace
- Every project in the workspace, if you are a workspace owner or manager
- Projects another workspace has connected to yours
Endpoints that need a project role or a workspace role list the allowed roles on their reference page.
Some actions are limited to the person who created the item:
- Editing or deleting a comment: its author
- Completing a file upload: the person who started it
- Completing a generation attachment upload: the person who started it
- Completing, canceling, or deleting a comment attachment: the person who uploaded it
Restricted files
Restricted reviewers see only files shared with them (allowRestricted is true).
The same applies when you reach a project through your workspace role without joining it.
Plan features
AI file generation and skills are available only on plans that include them.
Archived projects
Archived projects are read-only until you unarchive them. You can still get download URLs, remove project members, and delete access links.