Authentification

Chaque requête porte une clé API secrète du compte ORYKSA.

Envoyez la clé dans le Authorization header comme un bearer token (le X-API-Key header fonctionne aussi). Les clés commencent par oryk_live_.

curl https://api.oryksa.com/v1/account \
  -H "Authorization: Bearer oryk_live_YOUR_KEY"

const res = await fetch("https://api.oryksa.com/v1/account", {
  headers: { Authorization: "Bearer " + process.env.ORYKSA_API_KEY },
});

requests.get("https://api.oryksa.com/v1/account",
             headers={"Authorization": f"Bearer {os.environ['ORYKSA_API_KEY']}"})

Gestion des clés

Créez et révoquez des clés sur la page Clés API . Jusqu'à 10 clés actives par compte, une par application ou environnement est une bonne pratique.
La clé complète est affichée une seule fois. ORYKSA ne stocke qu'un hash SHA-256, donc une clé perdue ne peut pas être récupérée : révoquez-la et créez-en une nouvelle.
Une clé révoquée cesse de fonctionner immédiatement.

Gardez les clés sur le serveur. Une clé API donne accès à l'agent IA du compte, à la connaissance et aux conversations. Ne la publiez jamais dans un site web, un bundle d'application mobile ou un dépôt public. Pour les sites web, utilisez le chat widget, dont le token est public par conception.

URL de base et versions

Tous les endpoints sont sous https://api.oryksa.com/v1 et renvoient toujours du JSON. Les réponses aux erreurs incluent le header ORYKSA-Version. Les changements majeurs ne seront livrés que sous une nouvelle version (/v2).