Skip to main content
Every Public API key carries a list of operation scopes. Each endpoint requires one or more scopes; calls without the right scope return 403 Forbidden with { "error": { "code": "FORBIDDEN", "message": "Operation not allowed" } }.

​
Scope naming

Scopes use the form <resource>:<verb>. The available scopes today:
ScopeWhat it allows
conversation:readGET /v1/conversation/{id} and GET /v1/conversation/{id}/context
conversation:writePATCH /v1/conversation/{id}
client:readAll GET endpoints under /v1/client
client:writeAll POST and PATCH endpoints under /v1/client
user:readAll GET endpoints under /v1/user
address:readAll GET endpoints under /v1/address
address:writeAll POST and PATCH endpoints under /v1/address
Each endpoint’s required scope is also shown in the API Reference tab in the “Required permissions” callout under the endpoint summary.

​
Requesting scopes

When you request a key (see Authentication), describe what your integration will do. Support attaches the minimum set of scopes needed. Asking for “all scopes” will be rejected — least-privilege keys are the default.

​
Adding a new scope to an existing key

Email support@onevisionresources.com. Adding a scope does not change the key value; existing requests keep working while the new scope is attached.