Auf dieser Seite findest du die wichtigsten Möglichkeiten, mit der OpenAI API zu arbeiten. Du kannst die offiziellen SDKs in deinem Anwendungscode einsetzen, mit der OpenAI CLI direkt in der Shell arbeiten, das Agents SDK für die Orchestrierung nutzen oder API-Anfragen mit einem HTTP-Client deiner Wahl senden.
API-Schlüssel erstellen und exportieren
Erstelle zunächst einen API-Schlüssel im Dashboard. Mit diesem Schlüssel kannst du sicher auf die API zugreifen. Bewahre den Schlüssel an einem sicheren Ort auf, etwa in deiner .zshrc-Datei oder in einer anderen Textdatei auf deinem Computer. Sobald du den API-Schlüssel erstellt hast, exportiere ihn im Terminal als Umgebungsvariable.
export OPENAI_API_KEY="your_api_key_here"setx OPENAI_API_KEY "your_api_key_here"Die SDKs von OpenAI lesen deinen API-Schlüssel automatisch aus der Systemumgebung.
Offizielles SDK installieren
Mit dem offiziellen OpenAI SDK für TypeScript kannst du die OpenAI API in TypeScript-Anwendungen nutzen, die unter Node.js, Deno oder Bun laufen. Dasselbe Paket openai unterstützt auch reines JavaScript. Installiere das SDK zunächst mit npm oder dem Paketmanager deiner Wahl.
npm install openaiErstelle nach der Installation eine Datei namens example.mts und kopiere den Beispielcode hinein. Durch die Dateiendung .mts wird die TypeScript-Datei auch in CommonJS-Projekten als ES-Modul behandelt.
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);Führe den Code unter Node.js ab Version 22.6 mit node --experimental-strip-types example.mts aus. Wenn du Deno oder Bun verwendest, nutze den entsprechenden Befehl. Nach kurzer Zeit solltest du die Ausgabe deiner API-Anfrage sehen.
Um das Beispiel als reines JavaScript auszuführen, speichere denselben Code als example.mjs und führe node example.mjs aus.
In der README-Datei der Bibliothek auf GitHub findest du weitere Funktionen und Optionen des SDK.
Mit dem offiziellen OpenAI SDK für Python kannst du die OpenAI API in Python nutzen. Installiere zunächst das SDK mit pip.
pip install openaiSobald du das OpenAI SDK installiert hast, erstelle eine Datei namens example.py und kopiere den Beispielcode hinein.
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)Führe den Code mit python example.py aus. Nach kurzer Zeit solltest du die Antwort auf deine API-Anfrage sehen.
In der README-Datei der Bibliothek auf GitHub findest du weitere Funktionen und Optionen des SDK.
Gemeinsam mit Microsoft stellt OpenAI einen offiziell unterstützten API-Client für C# bereit. Du kannst ihn mit der .NET-CLI über NuGet installieren.
dotnet add package OpenAI
So sieht eine einfache Anfrage an die Responses API aus:
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 stellt für Java eine API-Bibliothek bereit. Mit der folgenden Konfiguration kannst du sie als Maven-Abhängigkeit einbinden.
<dependency>
<groupId>com.openai</groupId>
<artifactId>openai-java</artifactId>
<version>4.105.0</version>
</dependency>Das folgende Beispiel zeigt eine Anfrage an die Responses API.
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()));
}
}Im unten verlinkten GitHub-Repository erfährst du mehr darüber, wie du die OpenAI API in Java verwendest.
In der README-Datei der Bibliothek auf GitHub findest du weitere Funktionen und Optionen des SDK.
Sende mit dem Go-SDK deine erste Anfrage an die Responses API.
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())
}Im unten verlinkten GitHub-Repository erfährst du mehr darüber, wie du die OpenAI API in Go verwendest.
In der README der Bibliothek auf GitHub findest du weitere Funktionen und Optionen des SDK.
Mit dem offiziellen OpenAI SDK für Ruby kannst du die OpenAI API in Ruby nutzen. Füge dazu zuerst das Gem zu deiner Anwendung hinzu.
gem "openai"Sobald du das OpenAI SDK installiert hast, erstelle eine Datei namens example.rb und kopiere den folgenden Beispielcode hinein.
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)Führe den Code mit ruby example.rb aus. Nach kurzer Zeit solltest du die Antwort auf deine API-Anfrage sehen.
In der README-Datei der Bibliothek auf GitHub findest du weitere Funktionen und Optionen des SDK.
Um die OpenAI API direkt aus deinem Terminal aufzurufen, installiere das automatisch generierte Kommandozeilentool openai:
brew install openai/tools/openaiSende anschließend eine einfache API-Anfrage aus deiner 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'Nutze die CLI für wiederholbare Abläufe im Terminal. Du kannst damit strukturierte Daten aus Dateien extrahieren, Bilder generieren, gesprochene Sprache erzeugen und API-Aufrufe mit Shell-Werkzeugen wie jq kombinieren.
Erfahre mehr über Arbeitsabläufe mit der CLI und den Aufbau typischer Befehle.
Agents SDK verwenden
Verwende die oben aufgeführten offiziellen SDKs von OpenAI für direkte API-Anfragen. Nutze das Agents SDK, wenn deine Anwendung eine Orchestrierung direkt im Code benötigt, etwa für Agenten, Tools, Übergaben, Schutzmechanismen, Tracing oder die Ausführung in einer Sandbox.
Wenn du zwischen direkten API-Anfragen und der Orchestrierung im Code abwägst, hilft dir der Vergleich zwischen der Responses API und dem Agents SDK.
Entwickle deinen ersten Agenten mit dem Agents SDK.
Bibliotheken für Azure OpenAI
Das Azure-Team von Microsoft pflegt Bibliotheken, die sowohl mit der OpenAI API als auch mit den Diensten von Azure OpenAI kompatibel sind. In der jeweiligen Dokumentation erfährst du, wie du die Bibliothek mit der OpenAI API verwendest.
- Azure OpenAI: Clientbibliothek für .NET
- Azure OpenAI: Clientbibliothek für JavaScript
- Azure OpenAI: Clientbibliothek für Java
- Azure OpenAI: Clientbibliothek für Go
Bibliotheken aus der Community
Mitglieder der Community entwickeln und pflegen die folgenden Bibliotheken. Du kannst auch das Repository mit unserer OpenAPI-Spezifikation auf GitHub beobachten, um zeitnah über Änderungen an unserer API informiert zu werden.
Beachte, dass OpenAI diese Projekte weder auf Korrektheit noch auf Sicherheit prüft. Die Nutzung erfolgt auf eigene Gefahr!
Clojure
- openai-clojure von wkok
Dart/Flutter
Delphi
- DelphiOpenAI von HemulGM
Elixir
Kotlin
PHP
Rust
- async-openai von 64bit
Scala
Swift
- AIProxySwift von Lou Zell
- OpenAIKit von dylanshine
- OpenAI von MacPaw
Unity
Unreal Engine
Weitere Repositorys von OpenAI
- tiktoken zum Zählen von Tokens
simple-evals: Bibliothek für Evaluationen- mle-bench, eine Bibliothek zur Bewertung von Agenten, die Aufgaben aus dem Machine Learning Engineering bearbeiten
- gym, eine Bibliothek für Reinforcement Learning
- swarm, ein Repository zum Erlernen der Orchestrierung von Agenten