Référence API

Toutes les routes vivent sous /api/v1/external. Deux modèles d'authentification cohabitent, selon le domaine :

les domaines third-party attendent le JWT d'organisation de l'utilisateur dans Authorization, et chaque route exige un scope ;
le domaine Inférence attend une clé API dans Authorization, et accepte en option le jeton de l'utilisateur dans x-oreus-user-authorization pour lui facturer l'appel.

Chaque page donne les paramètres, les schémas, un exemple de requête dans sept langages et un formulaire d'essai. La référence est générée depuis les spécifications OpenAPI servies par le backend — elle ne peut pas diverger du code.

Compte

GETGet the account of the current user

/api/v1/external/account

Organisations

GETGet the organizations of the current user

/api/v1/external/organizations

GETGet the organizations owned by the current user

/api/v1/external/organizations/owned

GETGet an organization member by id

/api/v1/external/organizations/members/{memberId}

GETGet an organization by id

/api/v1/external/organizations/{organizationId}

GETGet the details of an organization

/api/v1/external/organizations/{organizationId}/details

GETGet the members of an organization

/api/v1/external/organizations/{organizationId}/members

GETGet the token consumption of an organization

/api/v1/external/organizations/{organizationId}/consumption

Agents

GETGet all agents

/api/v1/external/agents

POSTAdd an agent of the Vox library to the agents of the current user

/api/v1/external/agents/library/{storeItemId}

GETGet an agent by id

/api/v1/external/agents/{agentId}

Orbs

GETGet the orbs balance of the current user

/api/v1/external/orbs

GETGet the available orbs offers

/api/v1/external/orbs/offers

Vox

POSTSend a message to Vox, create a new session if needed

/api/v1/external/vox/run

GETGet the Vox chat starter sentences

/api/v1/external/vox/starter-sentences

Voxies

GETGet voxies of the current user

/api/v1/external/voxies

POSTCreate a voxie with default values

/api/v1/external/voxies

POSTCreate or update a Voxie configuration by prompt

/api/v1/external/voxies/prompt/run

POSTSend a message to a voxie

/api/v1/external/voxies/{voxieId}/run

GETGet a voxie by id

/api/v1/external/voxies/{voxieId}

PATCHUpdate a voxie

/api/v1/external/voxies/{voxieId}

DELETEDelete a voxie

/api/v1/external/voxies/{voxieId}

Sessions

GETGet sessions of the current user

/api/v1/external/sessions

GETGet agents for a session

/api/v1/external/sessions/agents

PATCHUpdate the agents attached to a session

/api/v1/external/sessions/agents

GETGet the number of shared agents in a session

/api/v1/external/sessions/agents/count

GETGet agents shareable by the current user

/api/v1/external/sessions/agents/me

GETGet runs for a session

/api/v1/external/sessions/{sessionId}/runs

GETGet a session by id

/api/v1/external/sessions/{sessionId}

PATCHUpdate a session

/api/v1/external/sessions/{sessionId}

Modèles

GETGet all AI models

List models or agents associated to the provided key

GETGet an AI model by id

/api/v1/external/models/{modelId}

Clés API

GETGet the API keys of the current organization

/api/v1/external/keys

POSTCreate an API key linked to a list of agents

/api/v1/external/keys/agent

POSTCreate an API key linked to a list of models

/api/v1/external/keys/model

DELETERevoke an API key

/api/v1/external/keys/{keyId}

Boutique

GETGet the store items

/api/v1/external/store

GETGet a store item by id

/api/v1/external/store/{storeItemId}

POSTPurchase an agent, a model or an application

/api/v1/external/store/buy

POSTRevoke the access to a store item

/api/v1/external/store/revoke

Avis

GETGet the reviews of a target

/api/v1/external/reviews/{targetId}

POSTCreate a review for a target

/api/v1/external/reviews/{targetId}

Connaissances

GETList knowledge documents of an agent or a folder

/api/v1/external/knowledges

Drives

GETGet the folders accessible to the current user

/api/v1/external/drives/folders

GETGet drive storage information

/api/v1/external/drives/infos

GETGet a folder by id

/api/v1/external/drives/folders/{folderId}

Fichiers

GETGet files in a folder

/api/v1/external/files/folders/{folderId}

POSTUpload files to a folder

/api/v1/external/files/folders/{folderId}

GETGet a file and its presigned URL

/api/v1/external/files/{fileId}

PATCHRename a file

/api/v1/external/files/{fileId}/name

PATCHMove files to another folder

/api/v1/external/files/folders/{targetFolderId}/move

DELETEDelete files from folders

/api/v1/external/files/folders

Inférence

GETList models or agents

List models or agents associated to the provided key

POSTChat completions

Generates a response from a model or agent based on the provided chat messages. Model key DTO will be 100% OpenAI SDK compatible, whereas Agent key DTO is more limited since agent config is already being used.

POSTUpload file

Upload a file that can be used across various endpoints. Individual files can be up to 512 MB

POSTCreate embeddings

Creates a vector embedding for the provided input text. Only available with a Model API key. Body is proxied to liteLLM — validation is handled by the upstream provider.