Scopes

API key scopes

A key's scopes are set when you create it. You can edit them later in Studio.

An endpoint that requires a scope names it on its reference page; a key without it gets a 403 insufficient_scope error.

A :write scope also satisfies the same resource's :read scope.

ScopeGrantsRequired by
interactive_avatars:writeCreate, update and delete interactive avatar sessions and avatars in the workspace.POST /api/interactive-avatars/sessions, POST /api/interactive-avatars/avatars

These endpoints need no scope with an API key: GET /api/billing/credits.