本页介绍了使用其进行构建的主要方式, OpenAI API:用于应用程序代码的官方 SDK,用于 Shell 原生工作流的 OpenAI CLI,用于编排的 Agents SDK,或者你首选的 HTTP 客户端。
创建并导出 API 密钥
在开始之前, 在控制面板中创建 API 密钥,你将使用它进行安全 访问 API。请将密钥存储在安全的位置,例如 .zshrc 文件 或计算机上的其他文本文件。生成 API 密钥后,将其导出为 环境变量 in your terminal.
1
export OPENAI_API_KEY="your_api_key_here"1
setx OPENAI_API_KEY "your_api_key_here"OpenAI SDK 已配置为自动从系统环境中读取您的 API 密钥。
安装官方 SDK
要在 Node.js、Deno 或 Bun 等服务端 JavaScript 环境中使用 OpenAI API,您可以使用官方的 适用于 TypeScript 和 JavaScript 的 OpenAI SDK。通过安装以下 SDK 开始使用 npm 或您首选的包管理器:
1
npm install openai安装 OpenAI SDK 后,创建一个名为 example.mjs 的文件,并将示例代码复制到其中:
1
2
3
4
5
6
7
8
9
import OpenAI from "openai";
const client = new OpenAI();
const response = await client.responses.create({
model: "gpt-5.5",
input: "Write a one-sentence bedtime story about a unicorn."
});
console.log(response.output_text);使用 node example.mjs 执行代码(或 Deno 和 Bun 的等效命令)。片刻之后,您应该就能看到 API 请求的输出结果。
前往该库的 GitHub README 探索更多 SDK 的功能与选项。
要在 Python 中使用 OpenAI API,您可以使用官方的 适用于 Python 的 OpenAI SDK。通过安装以下 SDK 开始使用 pip:
1
pip install openai安装 OpenAI SDK 后,创建一个名为 example.py 的文件,并将示例代码复制到其中:
1
2
3
4
5
6
7
8
9
from openai import OpenAI
client = OpenAI()
response = client.responses.create(
model="gpt-5.5",
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 的 API 请求如下所示:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
using System;
using System.Threading.Tasks;
using OpenAI;
class Program
{
static async Task Main()
{
var client = new OpenAIClient(
Environment.GetEnvironmentVariable("OPENAI_API_KEY")
);
var response = await client.Responses.CreateAsync(new ResponseCreateRequest
{
Model = "gpt-5.5",
Input = "Say 'this is a test.'"
});
Console.WriteLine($"[ASSISTANT]: {response.OutputText()}");
}
}OpenAI 为 Java 编程语言提供了一个 API 助手,目前处于测试阶段。你可以使用以下配置添加 Maven 依赖:
<dependency>
<groupId>com.openai</groupId>
<artifactId>openai-java</artifactId>
<version>4.0.0</version>
</dependency>
一个简单的对 Responses API 的 API 请求如下所示:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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-5.5")
.build();
Response response = client.responses().create(params);
System.out.println(response.outputText());
}
}要了解更多关于在 Java 中使用 OpenAI API 的信息,请查看下面链接的 GitHub 仓库!
前往该库的 GitHub README 探索更多 SDK 的功能与选项。
OpenAI 为 Go 编程语言提供了一个 API 助手,目前处于测试阶段。你可以使用以下代码导入该库:
import (
"github.com/openai/openai-go" // imported as openai
)
一个简单的对 Responses API 的 API 请求如下所示:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
package main
import (
"context"
"fmt"
"github.com/openai/openai-go/v3"
"github.com/openai/openai-go/v3/option"
"github.com/openai/openai-go/v3/responses"
)
func main() {
client := openai.NewClient(
option.WithAPIKey("My API Key"), // or set OPENAI_API_KEY in your env
)
resp, err := client.Responses.New(context.TODO(), openai.ResponseNewParams{
Model: "gpt-5.5",
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 的功能与选项。
要在 Ruby 中使用 OpenAI API,你可以使用官方的 适用于 Ruby 的 OpenAI SDK。请通过将 gem 添加到你的应用程序来开始使用:
1
gem "openai"安装 OpenAI SDK 后,创建一个名为 example.rb 的文件,并将示例代码复制到其中:
1
2
3
4
5
6
7
8
9
10
require "openai"
openai = OpenAI::Client.new
response = openai.responses.create(
model: "gpt-5.5",
input: "Write a one-sentence bedtime story about a unicorn."
)
puts(response.output_text)使用 ruby example.rb。稍后,你应该会看到 API 请求的输出。
前往该库的 GitHub README 探索更多 SDK 的功能与选项。
要直接从终端调用 OpenAI API,请安装生成的 openai 命令行工具:
1
brew install openai/tools/openai然后在你的 shell 中运行一个基本的 API 请求:
1
2
3
4
5
openai responses create \
--model "gpt-5.5" \
--input "Write a one-sentence bedtime story about a unicorn." \
--raw-output \
--transform 'output.#(type=="message").content.0.text'使用 CLI 来处理可重复的终端工作流,例如从文件中提取结构化数据、生成图像、创建语音,以及使用 shell 工具组合 API 调用,例如 jq.
了解更多关于 CLI 工作流和命令模式的信息。
使用 Agents SDK
请使用上方的官方 OpenAI SDK 进行直接的 API 请求。当你的应用需要针对 Agent、工具、交接、护栏、追踪或沙盒执行进行代码优先的编排时,请使用 Agents SDK。
使用 Agents SDK 构建你的第一个 Agent。
Azure OpenAI 库
Microsoft 的 Azure 团队维护着同时兼容 OpenAI API 和 Azure OpenAI 服务的库。请阅读下方的库文档,了解如何将它们与 OpenAI API 配合使用。
- 适用于 .NET 的 Azure OpenAI 客户端库
- 适用于 JavaScript 的 Azure OpenAI 客户端库
- 适用于 Java 的 Azure OpenAI 客户端库
- 适用于 Go 的 Azure OpenAI 客户端库
社区库
以下库由更广泛的开发者社区构建和维护。您还可以 watch 我们的 OpenAPI 规范 GitHub 仓库,以便在我们对 API 进行更改时及时获取更新。
请注意,OpenAI 不验证这些项目的正确性或安全性。 使用风险自负!
Clojure
Dart/Flutter
Delphi
Elixir
Kotlin
PHP
Rust
Scala
Swift
- AIProxySwift by Lou Zell
- OpenAIKit by dylanshine
- OpenAI by MacPaw
Unity
Unreal Engine
其他 OpenAI 仓库
- tiktoken - 计算令牌数
- simple-evals - 简易评估库
- mle-bench - 用于评估机器学习工程师智能体的库
- gym - 强化学习库
- swarm - 教育性编排仓库