Den vollständigen Index der Dokumentation findest du in llms.txt. Die Markdown-Version einer Dokumentationsseite erhältst du, indem du .md an die URL der Seite anhängst.
Hauptnavigation
Design

SDKs und CLI

Wähle das passende Werkzeug für die Entwicklung mit der OpenAI API. Nutze ein SDK für Anwendungen, die CLI für Arbeitsabläufe im Terminal oder das Agents SDK für die Orchestrierung.

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.

Umgebungsvariable unter macOS oder Linux exportieren
export 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.

OpenAI SDK mit npm installieren
npm install openai

Erstelle 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.

Einfache API-Anfrage testen
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.

Mehr auf GitHub erfahren

In der README-Datei der Bibliothek auf GitHub findest du weitere Funktionen und Optionen des SDK.

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.

Schnelleinstieg ins 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.


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

Dart/Flutter

Delphi

Elixir

Kotlin

PHP

Rust

Scala

Swift

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