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

建议

开始使用

核心概念

SDK 与 CLI

资源

旧版 API

API Dashboard
试用 ChatGPT

开发者快速入门

迈出使用 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 调用

要在 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 能力和选项。
Responses 入门应用

开始使用 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-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-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-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 智能体。