本页介绍使用 OpenAI API 进行开发的几种主要方式。您可以在应用代码中使用官方 SDK,在 shell 工作流中使用 OpenAI CLI,使用 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.2-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 的更多功能和选项。
要在 Python 中调用 OpenAI API,您可以使用官方的 OpenAI Python SDK。首先,使用 pip 安装 SDK:
pip install openai安装 OpenAI SDK 后,创建一个名为 example.py 的文件,并将以下示例代码复制到文件中:
from openai import OpenAI
client = OpenAI()
response = client.responses.create(
model="gpt-6.2-astra",
input="Write a one-sentence bedtime story about a unicorn.",
)
print(response.output_text)运行 python example.py 来执行示例代码。稍等片刻,您应该就能看到 API 请求的返回结果。
请参阅该库在 GitHub 上的 README,了解 SDK 的更多功能和选项。
OpenAI 与微软合作,为 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.2-astra",
"Say 'this is a test.'"
);
Console.WriteLine($"[ASSISTANT]: {response.GetOutputText()}");OpenAI 提供了用于调用 API 的 Java SDK。您可以使用以下配置添加 Maven 依赖:
<dependency>
<groupId>com.openai</groupId>
<artifactId>openai-java</artifactId>
<version>4.111.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.2-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.2-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.2-astra",
input: "Write a one-sentence bedtime story about a unicorn."
)
puts(response.output_text)运行 ruby example.rb 来执行示例代码。稍等片刻,您应该就能看到 API 请求返回的结果。
查看该库在 GitHub 上的 README,了解 SDK 的更多功能和选项。
要在终端中直接调用 OpenAI API,请先安装自动生成的 openai 命令行工具:
brew install openai/tools/openai然后在 shell 中发送一个基本的 API 请求:
openai responses create \
--model "gpt-6.2-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
虚幻引擎
OpenAI 的其他代码仓库
- tiktoken:用于统计 Token 数量
simple-evals:评测库- mle-bench:用于评测机器学习工程师智能体的库
- gym:强化学习库
- swarm:用于智能体编排教学的代码仓库