如需完整的文件索引,請參閱 llms.txt。在文件頁面的網址末尾加上 .md ,即可取得該頁面的 Markdown 版本。
主要導覽
主題

開發者快速入門

開始使用 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 呼叫

如果你的 TypeScript 應用程式在 Node.js、Deno 或 Bun 上執行,可以透過官方的 OpenAI TypeScript SDK 呼叫 OpenAI API。同一個 openai 套件也支援純 JavaScript。先使用 npm 或你慣用的套件管理工具安裝 SDK。

使用 npm 安裝 OpenAI SDK
npm install openai

安裝 OpenAI SDK 後,建立名為 example.mts 的檔案,並將下方的範例程式碼複製到檔案中。使用 .mts 副檔名,即使在 CommonJS 專案中,這個 TypeScript 檔案也會被視為 ES 模組。

測試基本的 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.js 22.6 或更新版本,請用 node --experimental-strip-types example.mts 執行範例程式。如果使用 Deno 或 Bun,請使用對應的指令。稍等片刻,應該就會看到這次 API 請求的輸出結果。

若要以純 JavaScript 執行這個範例,請將相同的程式碼另存為 example.mjs,然後執行 node example.mjs。

前往 GitHub 瞭解更多

閱讀 GitHub 上這個程式庫的 README,瞭解 SDK 的其他功能與選項。

Responses 入門範例應用程式

開始使用 Responses API 開發應用程式。

文字生成與提示詞撰寫

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

儲值點數以繼續開發

前往帳務頁面

恭喜你完成免費的 API 測試請求!接下來,你可以在更高的使用上限下開發實際應用程式,運用我們的模型生成文字、音訊、影像、影片等內容。

探索以下工具和文件,讓你的應用程式更快上線:

對話 Playground

撰寫並測試對話用的提示詞,再將提示詞嵌入應用程式。

建構智慧體

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

分析影像與檔案

將影像網址、已上傳的檔案或 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 智慧體。