本頁介紹使用 OpenAI API 開發的幾種主要方式。你可以在應用程式中使用官方 SDK、透過 OpenAI CLI 直接在 shell 中執行工作流程、使用 Agents SDK 協調智慧體工作流程,或選用自己慣用的 HTTP 用戶端。
建立並匯出 API 金鑰
開始前,請先在控制台建立 API 金鑰,以便安全地存取 API。請將金鑰存放在安全的位置,例如電腦上的 .zshrc 檔案或其他文字檔。產生 API 金鑰後,請在終端中將金鑰匯出為環境變數。
export OPENAI_API_KEY="your_api_key_here"setx 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 install openai安裝 OpenAI SDK 後,建立名為 example.mts 的檔案,並將下方的範例程式碼複製到檔案中。使用 .mts 副檔名,即使在 CommonJS 專案中,這個 TypeScript 檔案也會被視為 ES 模組。
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 上這個程式庫的 README,瞭解 SDK 的其他功能與選項。
你可以透過官方的 OpenAI Python SDK 在 Python 中呼叫 OpenAI API。先使用 pip 安裝 SDK:
pip install openai安裝 OpenAI SDK 後,建立名為 example.py 的檔案,並將下列範例程式碼複製到檔案中:
from openai import OpenAI
client = OpenAI()
response = client.responses.create(
model="gpt-6-astra",
input="Write a one-sentence bedtime story about a unicorn.",
)
print(response.output_text)使用 python example.py 執行程式。稍等片刻,應該就會看到 API 請求的回應。
請參閱這個套件在 GitHub 上的 README,瞭解 SDK 的其他功能與選項。
OpenAI 與 Microsoft 合作,提供官方支援的 C# API 用戶端。你可以使用 .NET CLI 從 NuGet 安裝這個套件。
dotnet add package OpenAI
以下範例示範如何向 Responses API 傳送簡單的請求。
using OpenAI.Responses;
#pragma warning disable OPENAI001
string key = Environment.GetEnvironmentVariable("OPENAI_API_KEY")!;
ResponsesClient client = new(key);
ResponseResult response = await client.CreateResponseAsync(
"gpt-6-astra",
"Say 'this is a test.'"
);
Console.WriteLine($"[ASSISTANT]: {response.GetOutputText()}");OpenAI 提供的 Java SDK 可用來呼叫 API。你可以使用下列設定,將 SDK 加入 Maven 專案的相依套件清單:
<dependency>
<groupId>com.openai</groupId>
<artifactId>openai-java</artifactId>
<version>4.105.0</version>
</dependency>以下範例示範如何向 Responses API 傳送請求:
import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.responses.Response;
import com.openai.models.responses.ResponseCreateParams;
public class Main {
public static void main(String[] args) {
OpenAIClient client = OpenAIOkHttpClient.fromEnv();
ResponseCreateParams params =
ResponseCreateParams.builder().input("Say this is a test").model("gpt-6-astra").build();
Response response = client.responses().create(params);
response.output().stream()
.flatMap(item -> item.message().stream())
.flatMap(message -> message.content().stream())
.flatMap(content -> content.outputText().stream())
.forEach(outputText -> System.out.println(outputText.text()));
}
}如需進一步瞭解如何在 Java 中使用 OpenAI API,請參閱下方連結的 GitHub 程式碼庫。
閱讀 GitHub 程式碼庫中的 README,進一步瞭解 SDK 的功能與選項。
使用 Go SDK 向 Responses API 傳送第一個請求:
package main
import (
"context"
"fmt"
"github.com/openai/openai-go/v3"
"github.com/openai/openai-go/v3/responses"
)
func main() {
client := openai.NewClient()
resp, err := client.Responses.New(context.TODO(), responses.ResponseNewParams{
Model: "gpt-6-astra",
Input: responses.ResponseNewParamsInputUnion{OfString: openai.String("Say this is a test")},
})
if err != nil {
panic(err.Error())
}
fmt.Println(resp.OutputText())
}如需進一步瞭解如何在 Go 中使用 OpenAI API,請參閱下方連結的 GitHub 程式碼庫。
閱讀這個程式庫在 GitHub 上的 README,瞭解 SDK 提供的其他功能與選項。
你可以透過官方的 OpenAI Ruby SDK 在 Ruby 中呼叫 OpenAI API。首先,將這個 gem 加入你的應用程式:
gem "openai"安裝 OpenAI SDK 後,建立名為 example.rb 的檔案,將下列範例程式碼複製到檔案中:
require "openai"
openai = OpenAI::Client.new
response = openai.responses.create(
model: "gpt-6-astra",
input: "Write a one-sentence bedtime story about a unicorn."
)
puts(response.output_text)使用 ruby example.rb 執行程式碼。稍等片刻,應該就能看到 API 請求的結果。
如需瞭解 SDK 的更多功能與選項,請參閱此函式庫在 GitHub 上的 README。
若要從終端直接呼叫 OpenAI API,請先安裝自動產生的 openai 指令列工具。
brew install openai/tools/openai接著,在 shell 中執行下列指令,送出一個基本的 API 請求。
openai responses create \
--model "gpt-6-astra" \
--input "Write a one-sentence bedtime story about a unicorn." \
--raw-output \
--transform 'output.#(type=="message").content.0.text'你可以使用 CLI 在終端中重複執行工作流程,例如從檔案擷取結構化資料、生成圖像、合成語音,或搭配 jq 等 shell 工具組合 API 呼叫。
進一步瞭解 CLI 工作流程和常見的指令用法。
使用 Agents SDK
若要直接傳送 API 請求,請使用上述 OpenAI 官方 SDK。如果應用程式需要以程式碼協調工作流程,例如管理智慧體、呼叫工具、交接任務、設定防護措施、追蹤執行過程或在沙盒中執行程式碼,請使用 Agents SDK。
如果你正在評估要直接傳送 API 請求,還是以程式碼協調工作流程,請參閱 Responses API 與 Agents SDK 的比較。
使用 Agents SDK 建立你的第一個智慧體。
Azure OpenAI 程式庫
Microsoft Azure 團隊維護的程式庫同時支援 OpenAI API 和 Azure OpenAI 服務。請參閱下列程式庫文件,瞭解如何透過這些程式庫使用 OpenAI API。
- 適用於 .NET 的 Azure OpenAI 用戶端程式庫
- 適用於 JavaScript 的 Azure OpenAI 用戶端程式庫
- 適用於 Java 的 Azure OpenAI 用戶端程式庫
- 適用於 Go 的 Azure OpenAI 用戶端程式庫
社群程式庫
下列程式庫由開發者社群建立並維護。你也可以在 GitHub 上關注我們的 OpenAPI 規格程式碼庫,以便在 API 變更時及時收到通知。
請注意,OpenAI 並未驗證這些專案的正確性或安全性。使用這些專案須自行承擔風險!
Clojure
- openai-clojure,作者為 wkok
Dart/Flutter
Delphi
- DelphiOpenAI,作者為 HemulGM
Elixir
Kotlin
PHP
Rust
- async-openai,作者為 64bit
Scala
Swift
- AIProxySwift,作者為 Lou Zell
- OpenAIKit,作者為 dylanshine
- OpenAI,作者為 MacPaw
Unity
Unreal Engine
其他 OpenAI 程式碼庫
- tiktoken - 計算 Token 數量
simple-evals:評估程式庫- mle-bench - 用於評估智慧體執行機器學習工程任務能力的程式庫
- gym - 強化學習程式庫
- swarm - 示範如何協調智慧體工作流程的教學程式碼庫