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

开发者快速入门

开始使用 OpenAI API。

通过 OpenAI API,您可以使用统一的接口调用先进的 AI 模型,完成文本生成、自然语言处理、计算机视觉等任务。先创建 API 密钥并发起首次 API 调用,再探索如何生成文本、分析图像和构建智能体。

创建并导出 API 密钥

创建 API 密钥

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

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

各语言的 OpenAI SDK 都会自动从系统环境变量中读取您的 API 密钥。

安装 OpenAI SDK 并发起 API 调用

如果您的 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 的更多功能和选项。

Responses API 入门示例应用

开始使用 Responses API 构建应用。

文本生成与提示编写

深入了解如何编写提示、使用消息角色和构建对话式应用。

添加额度,继续开发

前往账单页面

恭喜您完成了一次免费的 API 测试请求!添加额度后,您可以在更高的使用上限下开发实际应用,并使用我们的模型生成文本、音频、图像、视频等内容。

以下工具和文档可以帮助您更快地推出应用:

聊天 Playground

编写和测试对话提示,并将其嵌入您的应用。

构建智能体

使用 Agents SDK 构建、运行和观测智能体工作流。

分析图像和文件

将图像 URL、已上传的文件或 PDF 文档直接发送给模型,让模型提取文本、对内容进行分类或检测视觉元素。

分析图像内容
import OpenAI from "openai";
const client = new OpenAI();

const response = await client.responses.create({
  model: "gpt-6.2-astra",
  input: [
    {
      role: "user",
      content: [
        {
          type: "input_text",
          text: "What is in this image?",
        },
        {
          type: "input_image",
          image_url:
            "https://openai-documentation.vercel.app/images/cat_and_otter.png",
          detail: "auto",
        },
      ],
    },
  ],
});

console.log(response.output_text);
图像输入指南

了解如何将图像作为模型输入,让模型解读图像内容。

文件输入指南

了解如何将文件作为模型输入,让模型解读文档内容。

使用工具扩展模型能力

为模型添加工具,让模型能够访问外部数据和函数。您可以使用网页搜索或文件搜索等内置工具,也可以定义自己的工具来调用 API、运行代码或与第三方系统集成。

在生成响应时使用网页搜索
import OpenAI from "openai";
const client = new OpenAI();

const response = await client.responses.create({
  model: "gpt-6.2-astra",
  tools: [{ type: "web_search" }],
  input: "What was a positive news story from today?",
});

console.log(response.output_text);
使用内置工具

了解网页搜索和文件搜索等强大的内置工具。

函数调用指南

了解如何让模型调用您编写的代码。

流式传输响应并构建实时应用

通过服务器发送的流式事件,您可以在模型生成结果的同时将其展示给用户。您也可以使用 Realtime API 构建交互式语音应用,以及支持文本、音频和图像输入的应用。

以流式方式接收 API 的服务器发送事件
import { OpenAI } from "openai";
const client = new OpenAI();

const stream = await client.responses.create({
  model: "gpt-6.2-astra",
  input: [
    {
      role: "user",
      content: "Say 'double bubble bath' ten times fast.",
    },
  ],
  stream: true,
});

for await (const event of stream) {
  console.log(event);
}
使用流式事件

使用服务器发送事件,将模型响应以流式方式快速传输给用户。

Realtime API 入门

使用 WebRTC 或 WebSockets 构建响应极快的语音到语音 AI 应用。

构建智能体

在 OpenAI 平台上构建智能体,让它们代用户执行操作,例如操控计算机。使用 Agents SDK 在您的服务器上编写编排逻辑。

构建按语言分流请求的智能体
import { Agent, run } from "@openai/agents";

const spanishAgent = new Agent({
  name: "Spanish agent",
  instructions: "You only speak Spanish.",
});

const englishAgent = new Agent({
  name: "English agent",
  instructions: "You only speak English",
});

const triageAgent = new Agent({
  name: "Triage agent",
  instructions:
    "Handoff to the appropriate agent based on the language of the request.",
  handoffs: [spanishAgent, englishAgent],
});

const result = await run(triageAgent, "Hola, ¿cómo estás?");
console.log(result.finalOutput);
构建能执行操作的智能体

了解如何使用 OpenAI 平台构建功能强大的 AI 智能体。