API scopes
Synopsis
Each access token carries named scopes. An API request fails when the token lacks the required scope. Some scope groups useread, write, and admin levels. A higher level includes every lower level in the same group.
Example with output
This request uses an obviously fake token. Replace the token with a tenant API key from Settings → API Keys.Options
Operator tokens may carry
runner:*, platform-key:*, platform-library:*, model:*, or workspace:any. Tenant integrations do not need these scopes.
Errors
UZ-AUTH-022: Insufficient scope
The token lacks the scope named indetail. Create a new key with that scope, then retry the request.
Do not add unrelated scopes. A narrower key limits the effect of a leaked key.