English
主导航

旧版 API

SDK 与 CLI

选择合适的方式使用 OpenAI API 构建:用于应用程序的 SDK、用于终端工作流的 CLI,或用于编排的 Agents SDK。

本页介绍了使用其进行构建的主要方式, OpenAI API:用于应用程序代码的官方 SDK,用于 Shell 原生工作流的 OpenAI CLI,用于编排的 Agents SDK,或者你首选的 HTTP 客户端。

创建并导出 API 密钥

在开始之前, 在控制面板中创建 API 密钥,你将使用它进行安全 访问 API。请将密钥存储在安全的位置,例如 .zshrc 文件 或计算机上的其他文本文件。生成 API 密钥后,将其导出为 环境变量 in your terminal.

在 macOS 或 Linux 系统上导出环境变量
1
export OPENAI_API_KEY="your_api_key_here"

OpenAI SDK 已配置为自动从系统环境中读取您的 API 密钥。

安装官方 SDK

要在 Node.js、Deno 或 Bun 等服务端 JavaScript 环境中使用 OpenAI API,您可以使用官方的 适用于 TypeScript 和 JavaScript 的 OpenAI SDK。通过安装以下 SDK 开始使用 npm 或您首选的包管理器:

使用 npm 安装 OpenAI SDK
1
npm install openai

安装 OpenAI SDK 后,创建一个名为 example.mjs 的文件,并将示例代码复制到其中:

测试基本的 API 请求
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 上了解更多

前往该库的 GitHub README 探索更多 SDK 的功能与选项。

使用 Agents SDK

请使用上方的官方 OpenAI SDK 进行直接的 API 请求。当你的应用需要针对 Agent、工具、交接、护栏、追踪或沙盒执行进行代码优先的编排时,请使用 Agents SDK。

Agents SDK 快速入门

使用 Agents SDK 构建你的第一个 Agent。

Azure OpenAI 库

Microsoft 的 Azure 团队维护着同时兼容 OpenAI API 和 Azure OpenAI 服务的库。请阅读下方的库文档,了解如何将它们与 OpenAI API 配合使用。


社区库

以下库由更广泛的开发者社区构建和维护。您还可以 watch 我们的 OpenAPI 规范 GitHub 仓库,以便在我们对 API 进行更改时及时获取更新。

请注意,OpenAI 不验证这些项目的正确性或安全性。 使用风险自负!

Clojure

Dart/Flutter

Delphi

Elixir

Kotlin

PHP

Rust

Scala

Swift

Unity

Unreal Engine

其他 OpenAI 仓库