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

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

如果你的 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 的其他功能與選項。

使用 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 - 示範如何協調智慧體工作流程的教學程式碼庫