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

SDK 與 CLI

選擇適合你的 OpenAI API 開發方式:使用 SDK 開發應用程式、使用 CLI 處理終端工作流程,或使用 Agents SDK 進行編排。

本頁介紹使用 OpenAI API 開發的主要方式:使用官方 SDK 撰寫應用程式碼、使用 OpenAI CLI 建立 Shell 原生工作流程、使用 Agents SDK 進行編排,或使用你偏好的 HTTP 用戶端。

建立並匯出 API 金鑰

開始之前,請先在控制台中建立 API 金鑰,以便安全地存取 API。請將金鑰存放在安全的位置,例如電腦上的 .zshrc 檔案或其他文字檔。產生 API 金鑰後,請在終端中將它匯出為環境變數

在 macOS 或 Linux 系統上匯出環境變數
export OPENAI_API_KEY="your_api_key_here"

OpenAI SDK 已設定為自動從系統環境讀取你的 API 金鑰。

安裝官方 SDK

若要在 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 的更多能力與選項。

使用 Agents SDK

若要直接傳送 API 請求,請使用上述官方 OpenAI SDK。當應用程式需要以程式碼為核心,編排智慧體、工具、交接、防護機制、追蹤或沙盒執行時,請使用 Agents SDK。

如果你正在考慮要直接傳送 API 請求,還是採用以程式碼為核心的編排方式, 請參閱 Responses API 與 Agents SDK 的比較

Agents SDK 快速入門

使用 Agents SDK 建立你的第一個智慧體。

Azure OpenAI 程式庫

Microsoft 的 Azure 團隊維護了一系列同時相容於 OpenAI API 和 Azure OpenAI 服務的程式庫。請閱讀下列程式庫文件,瞭解如何搭配 OpenAI API 使用。


社群程式庫

下列程式庫由廣大的開發人員社群建立並維護。你也可以在 GitHub 上關注我們的 OpenAPI 規格程式碼庫,以便在我們變更 API 時即時收到更新通知。

請注意,OpenAI 不會驗證這些專案的正確性或安全性。 使用風險請自行承擔!

Clojure

Dart/Flutter

Delphi

Elixir

Kotlin

PHP

Rust

Scala

Swift

Unity

Unreal Engine

其他 OpenAI 程式碼庫

  • tiktoken - 計算 Token 數量
  • simple-evals - 簡易評估函式庫
  • mle-bench - 用於評估機器學習工程師智慧體的函式庫
  • gym - 強化學習函式庫
  • swarm - 用於教學的編排程式碼庫