Documentation développeurstableMis à jour 2026-07-08

Clés API

Créer, stocker, faire tourner et utiliser les clés API Kadryn depuis des applications serveur.

Les clés API Kadryn authentifient les requêtes serveur vers les surfaces développeur Kadryn comme Gateway, l’ingestion directe, les diagnostics et les workflows d’automatisation.

Utilisez les clés API pour connecter votre backend, vos workers, vos jobs d’ingestion ou vos services platform internes à Kadryn.

N’exposez jamais les clés API Kadryn dans du JavaScript navigateur, des apps mobiles, des dépôts publics, des logs client ou des URLs.

Ce que vous allez faire

Dans ce guide, vous allez:

  1. créer ou faire tourner une workspace API clé;
  2. stocker la clé de manière sûre dans des variables d’environnement côté serveur;
  3. utiliser le clé avec Kadryn API et Gateway requests;
  4. vérifier clé usage dans le Developers area;
  5. understand rotation, permissions et production sûrty rules.

Clés API vs clés provider

Key typePurposeWhere it est used
Kadryn API cléAuthenticates votre application à Kadryn.Gateway, ingestion directe, developer APIs.
Provider cléAllows Kadryn à appeler un provider IA route.Gateway execution, provider tests et route readiness.

Une requête Gateway a généralement besoin d’une clé API Kadryn dans la requête et d’une clé provider configurée dans le workspace.

Créer une clé API

Ouvrir :

Developers → API Keys

Sélectionnez ensuite :

Create API key

Si une clé existe déjà, utilisez :

Rotate API key

Kadryn affiche le secret complet une seule fois. Copiez-le immédiatement et stockez-le dans votre secret manager.

Kadryn continue d’afficher des métadonnées sûres comme le préfixe, la date de création et la date de dernière utilisation, mais n’affiche plus jamais le secret complet.

Stocker la clé

KADRYN_API_KEY="kadryn_live_..."
KADRYN_API_BASE_URL="https://api.kadryn.com/v1"
KADRYN_GATEWAY_BASE_URL="https://gateway.kadryn.com/v1"

Stockez these valeurs dans côté serveur secret stockage.

For local développement, utilisez une Git-ignored .env file.

Utiliser avec Gateway

curl "$KADRYN_GATEWAY_BASE_URL/chat/completions" \
  -H "Authorization: Bearer $KADRYN_API_KEY" \
  -H "Content-Type: application/json" \
  -H "X-Kadryn-Project: prod-api" \
  -H "X-Kadryn-Feature: support-agent" \
  -H "X-Kadryn-Environment: prod" \
  -d '{
    "model": "gpt-4.1-mini",
    "messages": [
      {
        "role": "user",
        "content": "Hello from Kadryn Gateway"
      }
    ]
  }'

Utiliser avec l’ingestion directe

curl "$KADRYN_API_BASE_URL/usage/events" \
  -H "Authorization: Bearer $KADRYN_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: usage-event-2026-07-06-001" \
  -d '{
    "timestamp": "2026-07-06T12:00:00.000Z",
    "provider": "openai",
    "model": "gpt-4.1-mini",
    "inputTokens": 1200,
    "outputTokens": 300,
    "costCents": "4",
    "project": "prod-api",
    "feature": "support-agent",
    "environment": "prod"
  }'

Inventaire des clés

The API Keys page shows:

  • clé name;
  • clé prefix;
  • environnement;
  • scopes;
  • statut;
  • last used date;
  • creation date.

Utilisez le préfixe pour identifier quelle clé déployée est active sans exposer le secret complet.

Permissions

Only utilisateurs avec workspace management permissions peut créer ou faire tourner API clés.

Si vous n’avez pas la permission, la page est en lecture seule. Vous pouvez inspecter les métadonnées sûres, mais vous ne pouvez pas générer ou faire tourner le secret.

Rotation

Faites tourner une clé API lorsque :

  • un clé peut ont been exposed;
  • un team member avec accès leaves;
  • vous move depuis test à production;
  • regular secret hygiene exige it;
  • old infrastructure still contient un clé.

Before rotating, identifier affected services:

  • variables d’environnement côté serveur;
  • SDK workloads;
  • Gateway authentication;
  • ingestion directe jobs;
  • internal workers;
  • CI/CD secrets.

After rotating:

  1. copy le new secret;
  2. mettez à jour votre secret manager;
  3. redeploy affected workloads;
  4. envoyer une non-sensible test request;
  5. vérifier le new last-used timestamp;
  6. remove old copies.

Règles de sécurité

Do:

  • stocker les clés uniquement côté serveur;
  • faites tourner les clés régulièrement;
  • restrict accès à owners, admins et deployment systems;
  • utiliser des idempotency keys pour les écritures retryables;
  • préserver traces pour debug production.

Do not:

  • expose clés dans frontend bundles;
  • paste clés dans tickets ou chat tools;
  • commit clés à Git;
  • log Authorization headers;
  • placer des secrets dans les URLs;
  • reutiliser production clés dans local experiments.

Dépannage

The page says manquant

No usable workspace API clé exists. Créez un clé, stocker it côté serveur, then retry.

Requests fail après rotation

Vérifiez que le new clé est stored dans production, all services ont été redeployed, workers ont été restarted et le old clé est pas still deployed somewhere.

Last used est empty

A clé peut be active mais unused. Envoyez un test Gateway ou ingestion directe request, then refresh le page.

I cannot faire tourner le clé

Your rôle est lecture seule pour ce operation. Ask un owner ou admin.

Pages liées