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

Schnellstart für Entwickelnde

Deine ersten Schritte mit der OpenAI API.

Die OpenAI API bietet eine einheitliche Schnittstelle zu KI-Modellen auf dem neuesten Stand der Technik. Du kannst sie für die Textgenerierung, die Verarbeitung natürlicher Sprache, Computer Vision und vieles mehr nutzen. Erstelle zunächst einen API-Schlüssel und führe deinen ersten API-Aufruf aus. Erfahre anschließend, wie du Texte generierst, Bilder analysierst, Agenten entwickelst und weitere Funktionen nutzt.

API-Schlüssel erstellen und exportieren

API-Schlüssel erstellen

Erstelle zuerst im Dashboard einen API-Schlüssel. Damit kannst du sicher auf die API zugreifen. Speichere den Schlüssel an einem sicheren Ort, etwa in deiner .zshrc-Datei oder in einer anderen Textdatei auf deinem Computer. Exportiere den erstellten API-Schlüssel im Terminal als Umgebungsvariable.

Umgebungsvariable unter macOS oder Linux exportieren
export OPENAI_API_KEY="your_api_key_here"

Jedes OpenAI SDK liest deinen API-Schlüssel automatisch aus der Systemumgebung.

OpenAI SDK installieren und einen API-Aufruf ausführen

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.

Beispiel-App für die Responses API

Nutze die App als Ausgangspunkt für die Entwicklung mit der Responses API.

Texte generieren und Prompts formulieren

Erfahre, wie du Prompts formulierst, mit Nachrichtenrollen arbeitest und Chat-Apps entwickelst.

Credits für die weitere Entwicklung hinzufügen

Zur Abrechnung

Glückwunsch zu deiner ersten kostenlosen API-Testanfrage! Entwickle jetzt Anwendungen für den praktischen Einsatz. Mit höheren Nutzungslimits kannst du unsere Modelle nutzen, um Texte, Audio, Bilder, Videos und mehr zu generieren.

Mit diesen Tools und Anleitungen kannst du deine App schneller veröffentlichen.

Chat Playground

Erstelle und teste Prompts für Dialoge und binde sie in deine App ein.

Agenten entwickeln

Mit dem Agents SDK kannst du Workflows für Agenten erstellen, ausführen und überwachen.

Bilder und Dateien analysieren

Sende Bild-URLs, hochgeladene Dateien oder PDF-Dokumente direkt an das Modell, um Text zu extrahieren, Inhalte zu klassifizieren oder Bildelemente zu erkennen.

Bildinhalt analysieren
import OpenAI from "openai";
const client = new OpenAI();

const response = await client.responses.create({
  model: "gpt-6-astra",
  input: [
    {
      role: "user",
      content: [
        {
          type: "input_text",
          text: "What is in this image?",
        },
        {
          type: "input_image",
          image_url:
            "https://openai-documentation.vercel.app/images/cat_and_otter.png",
          detail: "auto",
        },
      ],
    },
  ],
});

console.log(response.output_text);
Leitfaden zu Bildeingaben

Erfahre, wie du dem Modell Bilder übergibst und ihren Inhalt auswertest.

Leitfaden zu Dateieingaben

Erfahre, wie du dem Modell Dateien übergibst und Informationen aus Dokumenten gewinnst.

Das Modell mit Tools erweitern

Binde Tools ein, damit das Modell auf externe Daten und Funktionen zugreifen kann. Nutze integrierte Tools wie die Websuche oder die Dateisuche. Du kannst auch eigene Tools definieren, um APIs aufzurufen, Code auszuführen oder Drittsysteme anzubinden.

Websuche für eine Antwort nutzen
import OpenAI from "openai";
const client = new OpenAI();

const response = await client.responses.create({
  model: "gpt-6-astra",
  tools: [{ type: "web_search" }],
  input: "What was a positive news story from today?",
});

console.log(response.output_text);
Integrierte Tools nutzen

Erfahre, was integrierte Tools wie die Websuche und die Dateisuche leisten.

Leitfaden zu Funktionsaufrufen

Erfahre, wie du dem Modell ermöglichst, deinen eigenen Code aufzurufen.

Antworten streamen und Echtzeit-Apps entwickeln

Mit Streaming-Ereignissen, die der Server sendet, kannst du Ergebnisse schon während der Generierung anzeigen. Nutze die Realtime API für interaktive Sprach-Apps und Apps mit Text-, Audio- und Bildeingaben.

Server-Sent Events von der API streamen
import { OpenAI } from "openai";
const client = new OpenAI();

const stream = await client.responses.create({
  model: "gpt-6-astra",
  input: [
    {
      role: "user",
      content: "Say 'double bubble bath' ten times fast.",
    },
  ],
  stream: true,
});

for await (const event of stream) {
  console.log(event);
}
Streaming-Ereignisse nutzen

Mit Server-Sent Events kannst du Modellantworten ohne lange Wartezeit an die Menschen streamen, die deine App nutzen.

Erste Schritte mit der Realtime API

Nutze WebRTC oder WebSockets für KI-Apps mit besonders schneller Speech-to-Speech-Kommunikation.

Agenten entwickeln

Entwickle auf der OpenAI-Plattform Agenten, die im Auftrag der Menschen handeln, die deine App nutzen. Die Agenten können zum Beispiel Computer steuern. Mit dem Agents SDK legst du auf deinem Server fest, wie die Agenten zusammenarbeiten.

Einen Agenten entwickeln, der Anfragen nach Sprache weiterleitet
import { Agent, run } from "@openai/agents";

const spanishAgent = new Agent({
  name: "Spanish agent",
  instructions: "You only speak Spanish.",
});

const englishAgent = new Agent({
  name: "English agent",
  instructions: "You only speak English",
});

const triageAgent = new Agent({
  name: "Triage agent",
  instructions:
    "Handoff to the appropriate agent based on the language of the request.",
  handoffs: [spanishAgent, englishAgent],
});

const result = await run(triageAgent, "Hola, ¿cómo estás?");
console.log(result.finalOutput);
Agenten entwickeln, die Aktionen ausführen können

Erfahre, wie du mit der OpenAI-Plattform leistungsfähige KI-Agenten entwickelst.