For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
主导航

SDK 与 CLI

选择适合您的 OpenAI API 开发方式:使用 SDK 开发应用,使用 CLI 构建终端工作流,或使用 Agents SDK 进行编排。

本页介绍使用 OpenAI API 进行开发的主要方式:在应用代码中使用官方 SDK,使用 OpenAI CLI 构建 Shell 原生工作流,使用 Agents SDK 进行编排,或使用您偏好的 HTTP 客户端。

创建并导出 API 密钥

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

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

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

安装官方 SDK

要在 Node.js、Deno 或 Bun 等服务端 JavaScript 环境中使用 OpenAI API,您可以使用官方的 OpenAI SDK for TypeScript and JavaScript。首先,使用 npm 或您偏好的包管理器安装 SDK:

使用 npm 安装 OpenAI SDK
npm install openai

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

测试一个基本的 API 请求
import OpenAI from "openai";
const client = new OpenAI();

const response = await client.responses.create({
  model: "gpt-6-astra",
  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 请求。如果您的应用需要以代码为核心,编排智能体、工具、任务交接、护栏、追踪或沙盒执行,请使用 Agents SDK。

如果您正在直接发送 API 请求与以代码为核心的编排之间做选择, 请参阅 Responses API 与 Agents SDK 的比较

Agents SDK 快速入门

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

Azure OpenAI 库

微软的 Azure 团队维护着同时兼容 OpenAI API 和 Azure OpenAI 服务的库。请阅读下方的库文档,了解如何使用这些库调用 OpenAI API。


社区库

以下库由广大开发者社区成员构建和维护。您也可以在 GitHub 上关注我们的 OpenAPI 规范代码仓库,以便在我们更改 API 时及时获取更新。

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

Clojure

Dart/Flutter

Delphi

Elixir

Kotlin

PHP

Rust

Scala

Swift

Unity

Unreal Engine

其他 OpenAI 代码仓库