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.
export OPENAI_API_KEY="your_api_key_here"setx 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é :
npm install openaiUne fois le SDK OpenAI installé, créez un fichier nommé example.mjs et copiez-y le code d’exemple :
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.
Découvrez d’autres capacités et options du SDK dans le README de la bibliothèque sur GitHub.
Pour utiliser l’API OpenAI en Python, vous pouvez utiliser le SDK OpenAI officiel pour Python. Commencez par installer le SDK avec pip :
pip install openaiUne fois le SDK OpenAI installé, créez un fichier nommé example.py et copiez-y le code d’exemple :
from openai import OpenAI
client = OpenAI()
response = client.responses.create(
model="gpt-6-astra",
input="Write a one-sentence bedtime story about a unicorn.",
)
print(response.output_text)Exécutez le code avec python example.py. Vous devriez voir le résultat de votre requête API au bout de quelques instants.
Découvrez d’autres capacités et options du SDK dans le README de la bibliothèque sur GitHub.
En collaboration avec Microsoft, OpenAI propose un client API pour C# officiellement pris en charge. Vous pouvez l’installer depuis NuGet avec la CLI .NET.
dotnet add package OpenAI
Voici un exemple de requête simple à l’API Responses :
using OpenAI.Responses;
#pragma warning disable OPENAI001
string key = Environment.GetEnvironmentVariable("OPENAI_API_KEY")!;
ResponsesClient client = new(key);
ResponseResult response = await client.CreateResponseAsync(
"gpt-6-astra",
"Say 'this is a test.'"
);
Console.WriteLine($"[ASSISTANT]: {response.GetOutputText()}");OpenAI propose une bibliothèque pour utiliser son API en Java, actuellement en version bêta. Vous pouvez ajouter la dépendance Maven avec la configuration suivante :
<dependency>
<groupId>com.openai</groupId>
<artifactId>openai-java</artifactId>
<version>4.58.0</version>
</dependency>Voici un exemple de requête simple à l’API Responses :
import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.responses.Response;
import com.openai.models.responses.ResponseCreateParams;
public class Main {
public static void main(String[] args) {
OpenAIClient client = OpenAIOkHttpClient.fromEnv();
ResponseCreateParams params =
ResponseCreateParams.builder().input("Say this is a test").model("gpt-6-astra").build();
Response response = client.responses().create(params);
response.output().stream()
.flatMap(item -> item.message().stream())
.flatMap(message -> message.content().stream())
.flatMap(content -> content.outputText().stream())
.forEach(outputText -> System.out.println(outputText.text()));
}
}Pour en savoir plus sur l’utilisation de l’API OpenAI en Java, consultez le dépôt GitHub accessible ci-dessous !
Découvrez d’autres capacités et options du SDK dans le README de la bibliothèque sur GitHub.
OpenAI propose une bibliothèque utilitaire pour son API en Go, actuellement en bêta. Vous pouvez l’importer à l’aide du code ci-dessous :
import (
"github.com/openai/openai-go/v3" // imported as openai
)Voici à quoi ressemblerait une première requête à l’API Responses :
package main
import (
"context"
"fmt"
"github.com/openai/openai-go/v3"
"github.com/openai/openai-go/v3/responses"
)
func main() {
client := openai.NewClient()
resp, err := client.Responses.New(context.TODO(), responses.ResponseNewParams{
Model: "gpt-6-astra",
Input: responses.ResponseNewParamsInputUnion{OfString: openai.String("Say this is a test")},
})
if err != nil {
panic(err.Error())
}
fmt.Println(resp.OutputText())
}Pour en savoir plus sur l’utilisation de l’API OpenAI en Go, consultez le dépôt GitHub accessible ci-dessous !
Découvrez d’autres capacités et options du SDK dans le README de la bibliothèque sur GitHub.
Pour utiliser l’API OpenAI en Ruby, vous pouvez utiliser le SDK OpenAI pour Ruby officiel. Commencez par ajouter la gem à votre application :
gem "openai"Une fois le SDK OpenAI installé, créez un fichier nommé example.rb et copiez-y le code de l’exemple :
require "openai"
openai = OpenAI::Client.new
response = openai.responses.create(
model: "gpt-6-astra",
input: "Write a one-sentence bedtime story about a unicorn."
)
puts(response.output_text)Exécutez le code avec ruby example.rb. Au bout de quelques instants, vous devriez voir le résultat de votre requête API.
Découvrez d’autres capacités et options du SDK dans le fichier README de la bibliothèque sur GitHub.
Pour appeler l’API OpenAI directement depuis votre terminal, installez l’outil en ligne de commande généré openai :
brew install openai/tools/openaiExécutez ensuite une requête API simple depuis votre shell :
openai responses create \
--model "gpt-6-astra" \
--input "Write a one-sentence bedtime story about a unicorn." \
--raw-output \
--transform 'output.#(type=="message").content.0.text'Utilisez la CLI pour des workflows reproductibles dans le terminal, comme l’extraction de données structurées à partir de fichiers, la génération d’images, la synthèse vocale et la composition d’appels API avec des outils shell tels que jq.
Découvrez les workflows de la CLI et les structures de commandes courantes.
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.
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èque cliente Azure OpenAI pour .NET
- Bibliothèque cliente Azure OpenAI pour JavaScript
- Bibliothèque cliente Azure OpenAI pour Java
- Bibliothèque cliente Azure OpenAI pour Go
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
- openai-clojure par wkok
Dart/Flutter
Delphi
- DelphiOpenAI par HemulGM
Elixir
Kotlin
PHP
Rust
- async-openai par 64bit
Scala
Swift
- AIProxySwift par Lou Zell
- OpenAIKit par dylanshine
- OpenAI par MacPaw
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