Scopes
Les permissions de l'API, et les routes que chacune ouvre.
Chaque route third-party exige un scope, indiqué en tête de sa page. Un scope
s'obtient en deux temps : déclaré dans l'onglet Permissions de votre application dans
la console Oreus, puis demandé dans le paramètre scope de la requête d'autorisation.
L'un sans l'autre donne un jeton qui ne le porte pas — et un 403 sans autre explication. Voir
Configuration.
L'API Inférence n'utilise que read:inference et write:inference,
et seulement quand un jeton utilisateur est fourni.
La colonne Orbs signale les scopes dont l'usage consomme des orbs de l'utilisateur.
Compte
| Scope | Permet de | Orbs | Routes |
|---|---|---|---|
read:account | Lire le profil du compte | — | GET /account |
Clés API
| Scope | Permet de | Orbs | Routes |
|---|---|---|---|
read:keys | Lire les clés API | — | GET /keys |
write:keys | Créer des clés API | — | POST /keys/agentPOST /keys/model |
delete:keys | Révoquer des clés API | — | DELETE /keys/{keyId} |
Vox
| Scope | Permet de | Orbs | Routes |
|---|---|---|---|
read:vox | Lire les phrases d'amorce de Vox | — | GET /vox/starter-sentences |
write:vox | Envoyer des messages à Vox | oui | POST /vox/run |
Sessions
| Scope | Permet de | Orbs | Routes |
|---|---|---|---|
read:sessions | Lire les sessions | — | GET /sessionsGET /sessions/agentsGET /sessions/agents/countGET /sessions/agents/meGET /sessions/{sessionId}/runsGET /sessions/{sessionId} |
write:sessions | Modifier les sessions | — | PATCH /sessions/agentsPATCH /sessions/{sessionId} |
Voxies
| Scope | Permet de | Orbs | Routes |
|---|---|---|---|
read:voxies | Lire les voxies | — | GET /voxiesGET /voxies/{voxieId} |
write:voxies | Créer, exécuter et modifier des voxies | oui | POST /voxiesPOST /voxies/prompt/runPOST /voxies/{voxieId}/runPATCH /voxies/{voxieId} |
delete:voxies | Supprimer des voxies | — | DELETE /voxies/{voxieId} |
Agents
| Scope | Permet de | Orbs | Routes |
|---|---|---|---|
read:agents | Lire les agents | oui | GET /agentsGET /agents/{agentId} |
write:agents | Créer et modifier des agents | — | POST /agents/library/{storeItemId} |
read:knowledges | Lire les documents de connaissance | — | GET /knowledges |
Modèles
| Scope | Permet de | Orbs | Routes |
|---|---|---|---|
read:models | Lire les modèles | oui | GET /modelsGET /models/{modelId} |
Fichiers
| Scope | Permet de | Orbs | Routes |
|---|---|---|---|
read:files | Lire les fichiers | — | GET /files/folders/{folderId}GET /files/{fileId} |
write:files | Envoyer, renommer et déplacer des fichiers | oui | POST /files/folders/{folderId}PATCH /files/{fileId}/namePATCH /files/folders/{targetFolderId}/move |
delete:files | Supprimer des fichiers | — | DELETE /files/folders |
Drives
| Scope | Permet de | Orbs | Routes |
|---|---|---|---|
read:drives | Lire les drives et dossiers | — | GET /drives/foldersGET /drives/infosGET /drives/folders/{folderId} |
Boutique
| Scope | Permet de | Orbs | Routes |
|---|---|---|---|
read:stores | Lire le catalogue de la boutique | — | GET /storeGET /store/{storeItemId} |
write:stores | Acheter, révoquer et gérer des items | — | POST /store/buyPOST /store/revoke |
Organisations
| Scope | Permet de | Orbs | Routes |
|---|---|---|---|
read:organizations | Lire les organisations et leurs membres | — | GET /organizationsGET /organizations/ownedGET /organizations/members/{memberId}GET /organizations/{organizationId}GET /organizations/{organizationId}/detailsGET /organizations/{organizationId}/membersGET /organizations/{organizationId}/consumption |
Orbs
| Scope | Permet de | Orbs | Routes |
|---|---|---|---|
read:orbs | Lire le solde et les offres d’orbs | oui | GET /orbsGET /orbs/offers |
Avis
| Scope | Permet de | Orbs | Routes |
|---|---|---|---|
read:reviews | Lire les avis | — | GET /reviews/{targetId} |
write:reviews | Déposer des avis | — | POST /reviews/{targetId} |