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

SDK et CLI

Choisissez l’outil adapté à votre utilisation de l’API OpenAI : un SDK pour vos applications, la CLI pour vos workflows en ligne de commande ou le SDK Agents pour l’orchestration.

Cette page présente les principales façons d’utiliser l’API OpenAI : les SDK officiels dans le code de vos applications, la CLI d’OpenAI pour vos workflows en ligne de commande, le SDK Agents 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 pour accéder à l’API de manière sécurisée. Conservez cette clé en lieu sûr, par exemple dans votre fichier .zshrc ou dans un autre fichier texte sur votre ordinateur. Une fois la clé API générée, exportez-la dans votre terminal sous forme de variable d’environnement.

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

Par défaut, les SDK d’OpenAI lisent automatiquement votre clé API dans les variables d’environnement du système.

Installez un SDK officiel

Pour appeler l’API OpenAI depuis un environnement JavaScript côté serveur comme Node.js, Deno ou Bun, vous pouvez utiliser le SDK officiel d’OpenAI pour TypeScript et JavaScript. Commencez par installer le SDK avec npm ou le gestionnaire de paquets de votre choix.

Installation du 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 suivant.

Test d’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). Le résultat de votre requête devrait s’afficher au bout de quelques instants.

En savoir plus sur GitHub

Consultez le README de la bibliothèque sur GitHub pour découvrir d’autres fonctionnalités et options du SDK.

Utilisez le SDK Agents

Utilisez les SDK officiels d’OpenAI présentés ci-dessus pour envoyer des requêtes directement à l’API. Utilisez le SDK Agents si vous devez définir l’orchestration dans le code de votre application pour gérer les agents, les outils, les passages de relais entre agents, les garde-fous, le traçage ou l’exécution en bac à sable.

Pour choisir entre les appels directs à l’API et l’orchestration dans le code, consultez le comparatif de l’API Responses et du SDK Agents.

Prise en main du SDK Agents

Créez votre premier agent avec le SDK Agents.

Bibliothèques Azure OpenAI

L’équipe Azure de Microsoft maintient des 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

La communauté des développeurs crée et maintient les bibliothèques ci-dessous. Vous pouvez aussi suivre le dépôt de notre spécification OpenAPI sur GitHub pour recevoir des notifications lorsque nous modifions notre API.

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 d’OpenAI

  • tiktoken – comptage des tokens
  • simple-evals – bibliothèque d’évaluation simple
  • mle-bench – bibliothèque d’évaluation des 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