库
设置您的本地开发环境,以便使用 OpenAI API 与您喜好的语言 SDK。
创建并导出 API 密钥
在开始之前,在仪表板中创建一个 API 密钥,您将使用该密钥安全访问 API。将密钥存储在安全的位置,例如计算机上的 .zshrc 文件或其他文本文件。生成 API 密钥后,在终端中将其导出为环境变量。
macOS / Linux
export OPENAI_API_KEY="your_api_key_here"
Windows
setx OPENAI_API_KEY "your_api_key_here"
OpenAI SDK 会自动从系统环境中读取您的 API 密钥。
安装官方 SDK
JavaScript
要在 Node.js、Deno 或 Bun 等服务器端 JavaScript 环境中使用 OpenAI API,您可以使用官方的 OpenAI TypeScript 和 JavaScript SDK。通过 npm 或您喜欢的包管理器安装 SDK:
npm install openai
安装 OpenAI SDK 后,创建一个名为 example.mjs 的文件并将示例代码复制到其中:
import OpenAI from "openai";
const client = new OpenAI();
const response = await client.responses.create({
model: "gpt-5",
input: "Write a one-sentence bedtime story about a unicorn."
});
console.log(response.output_text);
使用 node example.mjs(或 Deno 或 Bun 的等效命令)执行代码。片刻后,您应该会看到 API 请求的输出。
Python
要在 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-5",
input="Write a one-sentence bedtime story about a unicorn."
)
print(response.output_text)
使用 python example.py 执行代码。片刻后,您应该会看到 API 请求的输出。
.NET
与微软合作,OpenAI 提供了一个官方支持的 C# API 客户端。您可以通过 NuGet 使用 .NET CLI 安装它。
dotnet add package OpenAI
一个简单的 API 请求到 Responses API 如下所示:
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",
Input = "Say 'this is a test.'"
});
Console.WriteLine($"[ASSISTANT]: {response.OutputText}");
}
}
Java
OpenAI 提供了一个 Java 编程语言的 API 辅助库,目前处于测试阶段。您可以使用以下配置包含 Maven 依赖项:
<dependency>
<groupId>com.openai</groupId>
<artifactId>openai-java</artifactId>
<version>4.0.0</version>
</dependency>
一个简单的 API 请求到 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-5")
.build();
Response response = client.responses().create(params);
System.out.println(response.outputText());
}
}
Go
OpenAI 提供了一个 Go 编程语言的 API 辅助库,目前处于测试阶段。您可以使用以下代码导入库:
import (
"github.com/openai/openai-go"
)
一个简单的 API 请求到 Responses API 如下所示:
package main
import (
"context"
"fmt"
"github.com/openai/openai-go/v3"
"github.com/openai/openai-go/v3/option"
)
func main() {
client := openai.NewClient(
option.WithAPIKey("My API Key"), // 或在您的环境中设置 OPENAI_API_KEY
)
resp, err := client.Responses.New(context.TODO(), openai.ResponseNewParams{
Model: openai.F("gpt-5"),
Input: openai.F("Say this is a test"),
})
if err != nil {
panic(err.Error())
}
fmt.Println(resp.OutputText)
}
Azure OpenAI 库
微软的 Azure 团队维护了与 OpenAI API 和 Azure OpenAI 服务兼容的库。阅读下面的库文档,了解如何将它们与 OpenAI API 一起使用。
社区库
以下库由更广泛的开发者社区构建和维护。您还可以关注我们的 OpenAPI 规范存储库,以便及时了解我们对 API 进行更改的情况。
请注意,OpenAI 不验证这些项目的正确性或安全性。请自行承担风险使用!
C# / .NET
C++
Clojure
Crystal
Dart/Flutter
Delphi
Elixir
Go
Java
Julia
Kotlin
Node.js
- openai-api by Njerschow
- openai-api-node by erlapso
- gpt-x by ceifa
- gpt3 by poteat
- gpts by thencc
- @dalenguyen/openai by dalenguyen
- tectalic/openai by tectalic
PHP
Python
R
Ruby
Rust
- async-openai by 64bit
- fieri by lbkolev
Scala
Swift
- AIProxySwift by Lou Zell
- OpenAIKit by dylanshine
- OpenAI by MacPaw
Unity
Unreal Engine
其他 OpenAI 存储库
- tiktoken - 计算令牌
- simple-evals - 简单的评估库
- mle-bench - 评估机器学习工程师代理的库
- gym - 强化学习库
- swarm - 教育编排存储库