For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Hauptnavigation

Schnellstart für Entwickelnde

Mach deine ersten Schritte mit der OpenAI API.

Die OpenAI API bietet eine einheitliche Schnittstelle zu modernsten KI-Modellen für Textgenerierung, die Verarbeitung natürlicher Sprache, Computer Vision und vieles mehr. Erstelle zunächst einen API-Schlüssel und führe deinen ersten API-Aufruf aus. Entdecke, wie du Texte generierst, Bilder analysierst, Agenten entwickelst und vieles mehr.

API-Schlüssel erstellen und exportieren

API-Schlüssel erstellen

Erstelle zunächst im Dashboard einen API-Schlüssel, mit dem du sicher auf die API zugreifen kannst. Speichere den Schlüssel an einem sicheren Ort, etwa in einer Datei namens .zshrc oder einer anderen Textdatei auf deinem Computer. Sobald du einen API-Schlüssel erstellt hast, exportiere ihn als Umgebungsvariable in deinem Terminal.

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

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:

OpenAI SDK mit npm installieren
npm install openai

Nachdem du das OpenAI SDK installiert hast, erstelle eine Datei namens example.mjs und kopiere den Beispielcode hinein:

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

Mehr auf GitHub erfahren

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

Einstiegs-App für Responses

Starte die Entwicklung mit der Responses API.

Textgenerierung und das Formulieren von Prompts

Erfahre mehr darüber, wie du Prompts formulierst, Nachrichtenrollen verwendest und dialogbasierte Apps entwickelst.

Credits hinzufügen und weiterentwickeln

Zur Abrechnung

Glückwunsch zu deiner kostenlosen API-Testanfrage! Entwickle jetzt mit höheren Limits echte Anwendungen und nutze unsere Modelle, um Text, Audio, Bilder, Videos und vieles mehr zu generieren.

Entdecke Tools und Dokumentation, mit denen du deine Anwendungen schneller veröffentlichen kannst:

Chat Playground

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

Agenten entwickeln

Nutze das Agents SDK, um Arbeitsabläufe für Agenten zu erstellen, auszuführen und zu beobachten.

Bilder und Dateien analysieren

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

Den Inhalt eines Bildes 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 als Eingabe übergibst und ihre Inhalte auswertest.

Leitfaden zu Dateieingaben

Erfahre, wie du dem Modell Dateien als Eingabe übergibst und Dokumentinhalte auswertest.

Das Modell mit Tools erweitern

Binde Tools ein, um dem Modell Zugriff auf externe Daten und Funktionen zu geben. Verwende integrierte Tools wie die Websuche oder Dateisuche oder definiere eigene Tools, um APIs aufzurufen, Code auszuführen oder Drittsysteme einzubinden.

Websuche in einer Antwort verwenden
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 verwenden

Lerne leistungsstarke integrierte Tools wie die Websuche und Dateisuche kennen.

Leitfaden zu Funktionsaufrufen

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

Antworten streamen und Echtzeit-Apps entwickeln

Verwende vom Server gesendete Streaming-Ereignisse, um Ergebnisse schon während ihrer Generierung anzuzeigen. Nutze die Realtime API für interaktive Sprach-Apps und Apps mit Text-, Audio- und Bildeingaben.

Vom Server gesendete Ereignisse aus 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 verwenden

Verwende vom Server gesendete Ereignisse, um Modellantworten schnell an die Nutzenden zu streamen.

Erste Schritte mit der Realtime API

Nutze WebRTC oder WebSockets für besonders schnelle Speech-to-Speech-KI-Apps.

Agenten entwickeln

Entwickle mit der OpenAI-Plattform Agenten, die im Auftrag deiner Nutzenden Aktionen ausführen können, zum Beispiel Computer steuern. Verwende das Agents SDK, um die Orchestrierungslogik auf deinem Server zu erstellen.

Einen Agenten zur Weiterleitung nach Sprache entwickeln
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 leistungsstarke KI-Agenten mit vielfältigen Fähigkeiten entwickelst.