Diese Seite stellt die wichtigsten Möglichkeiten vor, mit der OpenAI API zu entwickeln: offizielle SDKs für Anwendungscode, die OpenAI CLI für Arbeitsabläufe direkt in der Shell, das Agents SDK für die Orchestrierung oder deinen bevorzugten HTTP-Client.
Einen API-Schlüssel erstellen und exportieren
Bevor du beginnst, erstelle im Dashboard einen API-Schlüssel, mit dem du sicher auf die API zugreifen kannst. Bewahre den Schlüssel an einem sicheren Ort auf, etwa in einer .zshrc-Datei oder einer anderen Textdatei auf deinem Computer. Sobald du einen API-Schlüssel erstellt hast, exportiere ihn in deinem Terminal als Umgebungsvariable.
export OPENAI_API_KEY="your_api_key_here"setx OPENAI_API_KEY "your_api_key_here"Die OpenAI SDKs sind so konfiguriert, dass sie deinen API-Schlüssel automatisch aus der Systemumgebung lesen.
Ein offizielles SDK installieren
Um die OpenAI API in serverseitigen JavaScript-Umgebungen wie Node.js, Deno oder Bun zu nutzen, kannst du das offizielle OpenAI SDK für TypeScript und JavaScript verwenden. Installiere zunächst das SDK mit npm oder deinem bevorzugten Paketmanager:
npm install openaiNachdem du das OpenAI SDK installiert hast, erstelle eine Datei namens example.mjs und kopiere den Beispielcode hinein:
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 mit node example.mjs aus (oder dem entsprechenden Befehl für Deno oder Bun). Nach wenigen Augenblicken solltest du die Ausgabe deiner API-Anfrage sehen.
In der README der Bibliothek auf GitHub findest du weitere Funktionen und Optionen des SDK.
Um die OpenAI API in Python zu nutzen, kannst du das offizielle OpenAI SDK für Python verwenden. Installiere zunächst das SDK mit pip:
pip install openaiErstelle nach der Installation des OpenAI SDK 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 wenigen Augenblicken solltest du die Ausgabe deiner API-Anfrage sehen.
In der README der Bibliothek auf GitHub findest du weitere Funktionen und Optionen des SDK.
OpenAI stellt in Zusammenarbeit mit Microsoft einen offiziell unterstützten API-Client für C# bereit. Du kannst ihn mit der .NET CLI über NuGet installieren.
dotnet add package OpenAI
Eine einfache API-Anfrage an die Responses API könnte so aussehen:
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 eine API-Hilfsbibliothek für die Programmiersprache Java bereit, die sich derzeit in der Betaphase befindet. Du kannst die Maven-Abhängigkeit mit folgender Konfiguration einbinden:
<dependency>
<groupId>com.openai</groupId>
<artifactId>openai-java</artifactId>
<version>4.58.0</version>
</dependency>Eine einfache API-Anfrage an die Responses API sieht so aus:
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 der Bibliothek auf GitHub findest du weitere Funktionen und Optionen des SDK.
OpenAI bietet eine Hilfsbibliothek für die API in der Programmiersprache Go an, die sich derzeit in der Betaphase befindet. Du kannst die Bibliothek mit dem folgenden Code importieren:
import (
"github.com/openai/openai-go/v3" // imported as openai
)Eine erste API-Anfrage an die Responses API könnte so aussehen:
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())
}Mehr über die Verwendung der OpenAI API in Go erfährst du im unten verlinkten GitHub-Repository!
Entdecke weitere Funktionen und Optionen des SDK in der README der Bibliothek auf GitHub.
Um die OpenAI API in Ruby zu nutzen, kannst du das offizielle OpenAI SDK für Ruby verwenden. Füge zunächst das Gem zu deiner Anwendung hinzu:
gem "openai"Nachdem du das OpenAI SDK installiert hast, erstelle eine Datei namens example.rb und kopiere den 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 wenigen Augenblicken solltest du die Ausgabe deiner API-Anfrage sehen.
In der README der Bibliothek auf GitHub findest du weitere Funktionen und Optionen des SDK.
Um die OpenAI API direkt aus deinem Terminal aufzurufen, installiere das generierte Kommandozeilentool openai:
brew install openai/tools/openaiFühre anschließend eine einfache API-Anfrage in deiner Shell aus:
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 Arbeitsabläufe im Terminal, etwa um strukturierte Daten aus Dateien zu extrahieren, Bilder zu generieren, Sprachausgaben zu erzeugen und API-Aufrufe mit Shell-Tools wie jq zu kombinieren.
Erfahre mehr über CLI-Arbeitsabläufe und typische Befehlsmuster.
Das Agents SDK verwenden
Verwende die oben genannten offiziellen OpenAI SDKs für direkte API-Anfragen. Verwende das Agents SDK, wenn deine Anwendung eine codebasierte Orchestrierung für Agenten, Tools, Übergaben, Schutzmechanismen, Tracing oder die Ausführung in einer Sandbox benötigt.
Wenn du dich zwischen direkten API-Anfragen und codebasierter Orchestrierung entscheiden möchtest, lies den 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 Azure OpenAI-Diensten kompatibel sind. In der unten verlinkten Dokumentation der Bibliotheken erfährst du, wie du sie mit der OpenAI API verwenden kannst.
- 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
Die folgenden Bibliotheken werden von der Community für Entwickelnde erstellt und gepflegt. Du kannst auch auf GitHub das Repository unserer OpenAPI-Spezifikation beobachten, um zeitnah über Änderungen an unserer API informiert zu werden.
Bitte beachte, dass OpenAI diese Projekte nicht auf Korrektheit oder Sicherheit überprüft. Die Nutzung erfolgt auf eigenes Risiko!
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: Token zählen
- simple-evals: einfache Bibliothek zur Evaluierung
- mle-bench: Bibliothek zur Evaluierung von Agenten, die als Machine Learning Engineer arbeiten
- gym: Bibliothek für Reinforcement Learning
- swarm: Repository zur Orchestrierung für Lernzwecke