For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Navigation principale

SDK et CLI

Choisissez l’outil adapté pour développer avec l’API OpenAI : un SDK pour les applications, la CLI pour les workflows dans le terminal ou l’Agents SDK pour l’orchestration.

Cette page présente les principales façons de développer avec l’API OpenAI : les SDK officiels pour le code des applications, la CLI OpenAI pour les workflows directement dans le shell, l’Agents SDK pour l’orchestration ou le client HTTP de votre choix.

Créez et exportez une clé API

Avant de commencer, créez une clé API dans le tableau de bord. Elle vous permettra d’accéder à l’API de manière sécurisée. Conservez cette clé dans un endroit sûr, comme un fichier .zshrc ou un autre fichier texte sur votre ordinateur. Une fois la clé API générée, exportez-la sous forme de variable d’environnement dans votre terminal.

Exportez une variable d’environnement sur macOS ou Linux
export OPENAI_API_KEY="your_api_key_here"

Les SDK OpenAI sont configurés pour lire automatiquement votre clé API dans les variables d’environnement du système.

Installez un SDK officiel

Pour utiliser l’API OpenAI dans des environnements JavaScript côté serveur comme Node.js, Deno ou Bun, vous pouvez utiliser le SDK OpenAI officiel pour TypeScript et JavaScript. Commencez par installer le SDK avec npm ou votre gestionnaire de paquets préféré :

Installez le SDK OpenAI avec npm
npm install openai

Une fois le SDK OpenAI installé, créez un fichier nommé example.mjs et copiez-y le code d’exemple :

Testez une requête API simple
import OpenAI from "openai";
const client = new OpenAI();

const response = await client.responses.create({
  model: "gpt-6-astra",
  input: "Write a one-sentence bedtime story about a unicorn.",
});

console.log(response.output_text);

Exécutez le code avec node example.mjs (ou la commande équivalente pour Deno ou Bun). Au bout de quelques instants, vous devriez voir le résultat de votre requête API.

En savoir plus sur GitHub

Découvrez d’autres capacités et options du SDK dans le README de la bibliothèque sur GitHub.

Utilisez l’Agents SDK

Utilisez les SDK officiels OpenAI ci-dessus pour envoyer des requêtes directement à l’API. Utilisez l’Agents SDK lorsque votre application a besoin d’une orchestration définie dans le code pour gérer les agents, les outils, les transferts entre agents, les garde-fous, le traçage ou l’exécution en bac à sable.

Si vous hésitez entre des requêtes directes à l’API et une orchestration définie dans le code, consultez la comparaison entre l’API Responses et l’Agents SDK.

Démarrage rapide avec l’Agents SDK

Créez votre premier agent avec l’Agents SDK.

Bibliothèques Azure OpenAI

L’équipe Azure de Microsoft assure la maintenance de bibliothèques compatibles à la fois avec l’API OpenAI et les services Azure OpenAI. Consultez leur documentation ci-dessous pour savoir comment les utiliser avec l’API OpenAI.


Bibliothèques communautaires

Les bibliothèques ci-dessous sont développées et maintenues par la communauté des développeurs. Vous pouvez également suivre le dépôt de notre spécification OpenAPI sur GitHub pour être rapidement informé des modifications apportées à notre API.

Veuillez noter qu’OpenAI ne vérifie ni le bon fonctionnement ni la sécurité de ces projets. Utilisez-les à vos risques et périls !

Clojure

Dart/Flutter

Delphi

Elixir

Kotlin

PHP

Rust

Scala

Swift

Unity

Unreal Engine

Autres dépôts OpenAI

  • tiktoken - comptage des tokens
  • simple-evals - bibliothèque d’évaluation simple
  • mle-bench - bibliothèque pour évaluer les agents qui réalisent des tâches d’ingénierie en apprentissage automatique
  • gym - bibliothèque d’apprentissage par renforcement
  • swarm - dépôt pédagogique sur l’orchestration