Documentation

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

ScopePermet deOrbsRoutes
read:accountLire le profil du compte—GET /account

Clés API

ScopePermet deOrbsRoutes
read:keysLire les clés API—GET /keys
write:keysCréer des clés API—POST /keys/agent
POST /keys/model
delete:keysRévoquer des clés API—DELETE /keys/{keyId}

Vox

ScopePermet deOrbsRoutes
read:voxLire les phrases d'amorce de Vox—GET /vox/starter-sentences
write:voxEnvoyer des messages à VoxouiPOST /vox/run

Sessions

Voxies

ScopePermet deOrbsRoutes
read:voxiesLire les voxies—GET /voxies
GET /voxies/{voxieId}
write:voxiesCréer, exécuter et modifier des voxiesouiPOST /voxies
POST /voxies/prompt/run
POST /voxies/{voxieId}/run
PATCH /voxies/{voxieId}
delete:voxiesSupprimer des voxies—DELETE /voxies/{voxieId}

Agents

ScopePermet deOrbsRoutes
read:agentsLire les agentsouiGET /agents
GET /agents/{agentId}
write:agentsCréer et modifier des agents—POST /agents/library/{storeItemId}
read:knowledgesLire les documents de connaissance—GET /knowledges

Modèles

ScopePermet deOrbsRoutes
read:modelsLire les modèlesouiGET /models
GET /models/{modelId}

Fichiers

ScopePermet deOrbsRoutes
read:filesLire les fichiers—GET /files/folders/{folderId}
GET /files/{fileId}
write:filesEnvoyer, renommer et déplacer des fichiersouiPOST /files/folders/{folderId}
PATCH /files/{fileId}/name
PATCH /files/folders/{targetFolderId}/move
delete:filesSupprimer des fichiers—DELETE /files/folders

Drives

ScopePermet deOrbsRoutes
read:drivesLire les drives et dossiers—GET /drives/folders
GET /drives/infos
GET /drives/folders/{folderId}

Boutique

ScopePermet deOrbsRoutes
read:storesLire le catalogue de la boutique—GET /store
GET /store/{storeItemId}
write:storesAcheter, révoquer et gérer des items—POST /store/buy
POST /store/revoke

Organisations

Orbs

ScopePermet deOrbsRoutes
read:orbsLire le solde et les offres d’orbsouiGET /orbs
GET /orbs/offers

Avis

ScopePermet deOrbsRoutes
read:reviewsLire les avis—GET /reviews/{targetId}
write:reviewsDéposer des avis—POST /reviews/{targetId}

Sur cette page