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

建議

開始使用

核心概念

SDK 與 CLI

資源

舊版 API

API Dashboard
試用 ChatGPT

開發人員快速入門

踏出使用 OpenAI API 的第一步。

OpenAI API 提供一致的介面，讓你使用最先進的 AI 模型進行文字生成、自然語言處理、電腦視覺等工作。建立 API 金鑰並執行第一次 API 呼叫，即可開始使用。探索如何生成文字、分析圖像、建構智慧體，以及更多功能。

建立並匯出 API 金鑰

建立 API 金鑰

開始之前，請先在儀表板中建立 API 金鑰，用來 安全地存取 API。請將金鑰 存放在安全的位置，例如電腦上的 .zshrc 檔案或 其他文字檔案。產生 API 金鑰後，請在終端中 將它匯出為環境變數 。
在 macOS 或 Linux 系統上匯出環境變數
export OPENAI_API_KEY="your_api_key_here"

每個 OpenAI SDK 都會自動從系統環境讀取你的 API 金鑰。

安裝 OpenAI SDK 並執行 API 呼叫

若要在 Node.js、Deno 或 Bun 等伺服器端 JavaScript 環境中使用 OpenAI API，可以使用官方的 TypeScript 與 JavaScript 版 OpenAI SDK。首先，使用 npm 或你偏好的套件管理工具安裝 SDK：

使用 npm 安裝 OpenAI SDK
npm install openai

安裝 OpenAI SDK 後，建立名為 example.mjs 的檔案，並將範例程式碼複製到其中：

測試基本的 API 請求
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);

使用 node example.mjs（或 Deno 或 Bun 的對應指令）執行程式碼。稍候片刻，你應該就會看到 API 請求的輸出結果。

前往 GitHub 瞭解更多

查看此程式庫在 GitHub 上的 README，瞭解 SDK 的更多能力與選項。
Responses 入門應用程式

開始使用 Responses API 進行開發。
文字生成與提示詞

進一步瞭解提示詞、訊息角色，以及如何建構對話式應用程式。

加購點數，繼續開發

前往帳務頁面
恭喜你完成一次免費的 API 測試請求！現在就以更高的使用限額開始建構實際應用程式，並使用我們的模型生成文字、音訊、圖像、影片等內容。

探索可協助你更快推出產品的工具與文件：

對話 Playground

建立並測試對話提示詞，再將它們嵌入你的應用程式。
建構智慧體

使用 Agents SDK 建構、執行及觀察智慧體工作流程。

分析圖像與檔案

將圖像 URL、已上傳的檔案或 PDF 文件直接傳送給模型，以擷取文字、將內容分類或偵測視覺元素。
分析圖像內容
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);
圖像輸入指南

瞭解如何向模型提供圖像輸入，並解讀圖像內容。
檔案輸入指南

瞭解如何向模型提供檔案輸入，並解讀文件內容。

使用工具擴充模型能力

為模型加入工具，讓它能存取外部資料並使用外部函式。你可以使用網頁搜尋或檔案搜尋等內建工具，也可以定義自己的工具來呼叫 API、執行程式碼或整合第三方系統。
在回應中使用網頁搜尋
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);
使用內建工具

瞭解網頁搜尋和檔案搜尋等強大的內建工具。
函式呼叫指南

瞭解如何讓模型呼叫你自訂的程式碼。

串流回應並建立即時應用程式

使用伺服器傳送的串流事件，在結果生成時逐步顯示；或使用 Realtime API 建立互動式語音應用程式，以及支援文字、音訊和圖像輸入的應用程式。

以串流方式接收 API 的伺服器傳送事件
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);
}
使用串流事件

使用伺服器傳送事件，將模型回應快速串流傳送給使用者。
開始使用 Realtime API

使用 WebRTC 或 WebSockets 建立反應極快的語音到語音 AI 應用程式。

建立智慧體

使用 OpenAI 平台建立能代表使用者採取行動的智慧體，例如操作電腦。使用 Agents SDK 在你的伺服器上建立編排邏輯。

建立依語言分流的智慧體
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);
建立能採取行動的智慧體

瞭解如何使用 OpenAI 平台建立功能強大、能勝任任務的 AI 智慧體。