Configurer la clé API

Guidez l'utilisateur pour obtenir une clé API Runway, installer le SDK et configurer son projet pour l'accès API.

PRÉREQUIS : Exécutez d'abord +rw-check-compatibility pour vous assurer que le projet dispose d'une capacité côté serveur.

Étape 1 : Créer un compte développeur Runway

Dirigez l'utilisateur vers :

1. Allez à https://dev.runwayml.com/
2. Créez une organisation (ou utilisez une existante)
3. Naviguez vers Organization Settings → API Keys
4. Cliquez sur Create API Key
5. Copiez la clé immédiatement — elle n'est affichée qu'une seule fois et ne peut pas être récupérée

Avertissements importants à communiquer à l'utilisateur :

• Les clés perdues ne peuvent pas être récupérées. Si elle est perdue, désactivez l'ancienne clé et créez-en une nouvelle.
• Les clés API sont au niveau de l'organisation, pas au niveau de l'utilisateur.
• Vous devez prépayer des crédits avant que l'API fonctionne. L'achat minimum est de 10 $ (1 000 crédits à 0,01 $/crédit). Faites-le à https://dev.runwayml.com/ sous la section facturation.

Étape 2 : Installer le SDK

Node.js

npm install @runwayml/sdk

Nécessite Node.js 18+. Le SDK inclut les définitions de types TypeScript.

Python

pip install runwayml

Nécessite Python 3.8+. Inclut les annotations de type MyPy.

Étape 3 : Configurer la variable d'environnement

Le SDK lit automatiquement la clé API à partir de la variable d'environnement RUNWAYML_API_SECRET.

Option A : fichier .env (recommandé pour le développement)

Vérifiez si le projet dispose déjà d'un fichier .env. Si c'est le cas, ajoutez-y. Sinon, créez-en un.

RUNWAYML_API_SECRET=your_api_key_here

Pour les projets Node.js : Assurez-vous que le projet charge les fichiers .env :

• Next.js, Remix, Vite — support .env natif, aucune configuration supplémentaire nécessaire
• Express/Fastify/Node simple — installez dotenv :

  npm install dotenv

  Ajoutez au point d'entrée :

  import 'dotenv/config';

Pour les projets Python : Assurez-vous que python-dotenv est installé si vous n'utilisez pas de framework avec support natif :

pip install python-dotenv

Ajoutez au point d'entrée :

from dotenv import load_dotenv
load_dotenv()

Option B : variable d'environnement système

export RUNWAYML_API_SECRET=your_api_key_here

Option C : Passer directement au client (non recommandé)

// Node.js
const client = new RunwayML({ apiKey: 'your_api_key_here' });

# Python
client = RunwayML(api_key='your_api_key_here')

Avertissez l'utilisateur : Ne codez jamais les clés en dur dans le code source. Utilisez des variables d'environnement ou un gestionnaire de secrets.

Étape 4 : Mettre à jour .gitignore

Assurez-vous que .env figure dans .gitignore pour éviter de valider accidentellement la clé API :

.env
.env.local
.env.*.local

Vérifiez le fichier .gitignore existant et ajoutez l'entrée s'il manque.

Étape 5 : Vérifier la configuration

Suggérez à l'utilisateur d'exécuter une vérification rapide :

Node.js

import RunwayML from '@runwayml/sdk';

const client = new RunwayML();
// Si aucune erreur n'est levée, la clé API est correctement configurée
console.log('Runway SDK initialized successfully');

Python

from runwayml import RunwayML

client = RunwayML()
# Si aucune erreur n'est levée, la clé API est correctement configurée
print('Runway SDK initialized successfully')

Étape 6 : Confirmer le solde de crédits

Rappelez à l'utilisateur :

• L'API nécessite des crédits prépayés pour fonctionner
• Achat minimum : 10 $ (1 000 crédits)
• Achetez à : https://dev.runwayml.com/ → Billing
• Il peut vérifier son solde via l'API :

// Node.js - vérifier les infos de l'organisation
const response = await fetch('https://api.dev.runwayml.com/v1/organization', {
  headers: {
    'Authorization': `Bearer ${process.env.RUNWAYML_API_SECRET}`,
    'X-Runway-Version': '2024-11-06'
  }
});
const org = await response.json();
console.log('Credits:', org.creditBalance);

Liste de vérification de sécurité

Avant de continuer, vérifiez :

• [ ] La clé API est stockée dans une variable d'environnement, pas codée en dur
• [ ] Le fichier .env figure dans .gitignore
• [ ] Les appels API ne se produiront que côté serveur (pas dans le code exécuté par le navigateur)
• [ ] L'utilisateur a acheté des crédits

Prochaines étapes

Une fois la clé API configurée, l'utilisateur peut procéder à l'intégration :

• +rw-integrate-video — Génération vidéo (text-to-video, image-to-video)
• +rw-integrate-image — Génération d'image
• +rw-integrate-audio — Génération audio (TTS, effets sonores, voix)
• +rw-integrate-uploads — Téléchargement de fichiers pour les modèles nécessitant une image/vidéo en entrée