API Access#

Les clés API permettent à votre propre code, à vos scripts et à vos intégrations d'appeler QAnswer sans session navigateur. Toutes les clés que vous pouvez gérer depuis votre espace personnel sont réunies sur une seule page : celles que vous créez vous-même et celles que QAnswer a générées pour vous lors du partage d'un assistant ou de la connexion d'une intégration.

Ouvrez API Access dans le menu de navigation à gauche.

Une ligne par clé : son nom, un badge indiquant de quel type de clé il s'agit, les derniers caractères de sa valeur, sa date d'expiration et sa consommation de crédits. Les trois icônes à droite copient la clé, ouvrent son onglet API ou la suppriment.

Un clic sur une clé ouvre sa propre page. Le haut affiche le nom de la clé, son type et sa valeur masquée, avec un bouton de copie et un bouton de suppression. En dessous, trois onglets se partagent le reste — Info, Statistics et API — et la page s'ouvre sur Info.

Créer une clé API#

Cliquez sur Create API key et remplissez les options :

• Nom (obligatoire) — un libellé pour identifier la clé, par exemple l'intégration qui l'utilise.
• Type d'accès (optionnel) — ce que la clé peut faire avec vos droits : Read and write par défaut, Read only ou Use only. Voir Types d'accès ci-dessous.
• Date d'expiration (optionnel) — la clé cesse automatiquement de fonctionner après cette date. Choisissez un jour dans le calendrier ou saisissez la date au format JJ/MM/AAAA.
• Quota de crédits de question (optionnel) — le nombre maximal de crédits de question que cette clé peut consommer.
• Capacité de crédit (optionnel) — le montant maximal que cette clé peut dépenser en usage des fournisseurs.

Chaque champ optionnel peut être vidé grâce au bouton d'effacement à sa droite : une expiration, un quota ou une capacité saisis par erreur redeviennent illimités en un clic.

QAnswer crée la clé et vous emmène directement sur sa page de détail. La valeur y est affichée une seule fois, en clair, dans un bandeau en haut de la page, avec un bouton Copy.

Types d'accès#

Le type d'accès restreint ce qu'une clé User peut faire avec vos droits. Il n'en ajoute jamais : une clé ne peut rien faire que votre propre compte ne puisse pas faire.

• Read and write – la clé agit en votre nom, avec tous vos droits. C'est le type d'accès par défaut.
• Read only – la clé peut lire tout ce que vous pouvez lire et utiliser les assistants : le chat, les endpoints /api/v1 chat completions, messages et embeddings, et les recherches. Toute autre modification est refusée avec un HTTP 403 (APIKEY_MUTATION_FORBIDDEN) et rien n'est exécuté. Elle ne peut pas non plus créer ni lire de clés API, exporter les identifiants des fournisseurs ou lancer une connexion OAuth.
• Use only – les mêmes appels que Read only, mais sur chaque assistant, fournisseur ou autre ressource, la clé est plafonnée à Use only — le même sens que lorsqu'un assistant est partagé avec ce type d'accès : elle peut discuter avec l'assistant, mais pas consulter ses journaux ni modifier ses paramètres.

Le type d'accès s'affiche à la ligne Type d'accès de l'onglet Info de la clé et ne peut plus être modifié après la création : pour en changer, créez une nouvelle clé et supprimez l'ancienne.

Ce qu'une clé peut atteindre#

Chaque clé porte un badge qui indique à quoi elle sert. Il existe deux types :

• User – une clé qui n'est liée à aucune ressource — le type que vous créez sur cette page. Elle agit en votre nom, dans la limite de son type d'accès : en Read and write, tout ce que votre compte peut faire via l'API, cette clé peut le faire.
• Assistant – une clé liée à exactement un assistant IA. Elle ne peut appeler que les endpoints de cet assistant — rien d'autre dans QAnswer.

Les clés d'assistant ne se créent pas depuis cette page. Elles sont générées sur l'assistant lui-même — lorsque vous partagez un assistant IA avec une clé API ou que vous le connectez à Slack, Discord ou Teams — puis apparaissent ici pour que vous puissiez les suivre et les révoquer au même endroit.

Une clé d'assistant peut discuter avec cet assistant et y faire des recherches, et atteindre ses conversations, ses sources de données et ses métadonnées. Partout ailleurs, elle est refusée.

En particulier, une clé d'assistant ne peut jamais :

• lire ou modifier votre profil, vos organisations, vos équipes, ni les partages d'une ressource ;
• lister, créer ou supprimer des clés API — y compris elle-même ;
• atteindre les endpoints d'administration, de facturation ou de branding ;
• lire ou exporter la configuration d'un modèle de langage, d'un embedder ou de tout autre fournisseur ;
• supprimer ou exporter l'assistant auquel elle est liée, ni toucher à un autre assistant.

Utiliser une clé#

Ouvrez une clé et sélectionnez son onglet API, ou cliquez sur l'icône livre de sa ligne pour y arriver directement. Chaque API que votre compte peut utiliser a sa propre carte : chat completions, embeddings, speech-to-text et chat avec un assistant IA. Web search et image generation n'ont pas d'extrait — ils s'utilisent comme outils dans une conversation d'assistant plutôt qu'en appel direct.

Une carte affiche la méthode HTTP et le chemin, puis se déplie sur un extrait prêt à l'emploi, la clé déjà placée dans l'en-tête. Une seule carte est ouverte à la fois : en ouvrir une autre referme la précédente. Les onglets au-dessus de l'extrait basculent entre cURL, Python et JavaScript, et le bouton Copy copie le langage affiché. Lorsqu'un appel a besoin d'un modèle ou d'un assistant, le sélecteur à côté du chemin choisit celui qu'utilise l'exemple.

Chaque endpoint est documenté dans la référence de l'API, également accessible depuis le haut de la section.

Pour une clé d'assistant, l'onglet API est plus court et l'explique : il ne liste que les appels que cette clé est autorisée à faire, sur l'assistant qu'il nomme.

Suivre l'usage d'une clé#

L'onglet Info de la page d'une clé affiche :

• Expiry — la date à laquelle la clé cesse de fonctionner, ou No expiry.
• Status — Active, ou Expired une fois cette date passée.
• Access Type — Read and write, Read only ou Use only, choisi à la création de la clé. Voir Types d'accès plus haut.
• Credit session start — le jour où la période de quota en cours a commencé.
• Question credits — les crédits de question consommés sur le quota de la clé, sous la forme consommés / total.
• Credit capacity — la limite de dépense fixée à la création, ou Unlimited.
• Credits used — le total courant pour cette clé.

L'onglet Statistics montre ce que la clé a consommé ce mois-ci, avec une section par famille de fournisseurs ayant enregistré de l'usage : LLM, embedder, web search, image generation ou speech-to-text. Chaque section contient les chiffres clés (appels, tokens, coût), un graphique qui bascule entre Calls, Tokens et Cost ($), un tableau par jour et un bouton Export. Les champs de date et le filtre AI Assistant restreignent la période ou l'assistant, et le bouton d'actualisation recharge les chiffres.

Une clé sans usage ce mois-ci affiche à la place « No usage recorded yet for this key. ».

Gérer vos clés#

• Le champ de recherche filtre la liste par nom de clé.
• Le menu de tri à côté trie la liste par Creation date, Name, Expiry date ou Credits used. Une clé sans expiration compte comme la dernière à expirer.
• Le bouton flèche à droite du menu de tri alterne entre ordre décroissant et croissant, et son infobulle indique l'ordre actuel. Par défaut, le tri se fait par Creation date, décroissant : la clé la plus récente vient en premier.
• Le bouton grille, après les contrôles de tri, fait basculer la liste entre lignes et cartes.
• L'entrée Select du menu à trois points, à la fin de la barre d'outils, active la sélection multiple : cochez plusieurs clés, puis supprimez-les en une seule opération.
• L'icône corbeille d'une ligne supprime cette clé après confirmation.
• Une clé expirée reste dans la liste, grisée et marquée Expired, jusqu'à ce que vous la supprimiez. Entre-temps, l'API la refuse.