如需查看完整的文档索引,请参阅 llms.txt。在文档页面的 URL 末尾加上 .md 即可查看该页面的 Markdown 版本。
主导航
主题

SDK 和 CLI

根据您的开发场景选择使用 OpenAI API 的方式:开发应用时使用 SDK,在终端中运行工作流时使用 CLI,编排智能体时使用 Agents SDK。

本页介绍使用 OpenAI API 进行开发的几种主要方式。您可以在应用代码中使用官方 SDK,在 shell 工作流中使用 OpenAI CLI,使用 Agents SDK 编排智能体,也可以使用您熟悉的 HTTP 客户端。

创建并导出 API 密钥

开始之前,请先在控制台中创建 API 密钥,以便安全地访问 API。请将密钥保存在安全的位置,例如您计算机上的 .zshrc 文件或其他文本文件。生成 API 密钥后,请在终端中将其导出为环境变量。

在 macOS 或 Linux 系统中导出环境变量
export 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 安装 OpenAI SDK
npm install openai

安装 OpenAI SDK 后,创建一个名为 example.mts 的文件,并将以下示例代码复制到该文件中。使用 .mts 扩展名后,即使在 CommonJS 项目中,这个 TypeScript 文件也会被视为 ES 模块。

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

查看该库在 GitHub 上的 README,了解 SDK 的更多功能和选项。

使用 Agents SDK

如需直接发送 API 请求,请使用上文介绍的 OpenAI 官方 SDK。如果您的应用需要通过代码编排智能体、工具调用、任务交接、安全防护、追踪或沙盒执行流程,请使用 Agents SDK。

如果您正在考虑直接发送 API 请求还是通过代码进行编排,请参阅 Responses API 与 Agents SDK 的对比。

Agents SDK 快速入门

使用 Agents SDK 构建您的第一个智能体。

Azure OpenAI 库

Microsoft 的 Azure 团队维护的客户端库同时兼容 OpenAI API 和 Azure OpenAI 服务。请阅读下列文档,了解如何使用这些库调用 OpenAI API。


社区库

以下库由开发者社区构建和维护。您也可以在 GitHub 上关注我们的 OpenAPI 规范代码仓库,及时获知 API 的变更。

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

Clojure

Dart/Flutter

Delphi

Elixir

Kotlin

PHP

Rust

Scala

Swift

Unity

虚幻引擎

OpenAI 的其他代码仓库

  • tiktoken:用于统计 Token 数量
  • simple-evals:评测库
  • mle-bench:用于评测机器学习工程师智能体的库
  • gym:强化学习库
  • swarm:用于智能体编排教学的代码仓库