English
主导航

推荐

入门

核心概念

Apps SDK

工具

运行与扩展

评估

实时与音频

模型优化

专业模型

正式上线

旧版 API

资源

API 仪表板

开发者快速入门

迈出使用 OpenAI API 的第一步。

OpenAI API 为最先进的 AI 提供了简单的接口， 视觉 涵盖文本生成、自然语言处理、计算机视觉等功能。请先创建一个 API 密钥并运行你的首个 API 调用，以此为起点。探索如何生成文本、分析图像、构建智能体以及更多功能。

创建并导出 API 密钥

创建 API 密钥

在开始之前，请在控制台中创建一个 API 密钥，你将使用它来安全地 访问 API。请将密钥存储在安全的位置，例如 .zshrc 文件 或计算机上的其他文本文件。生成 API 密钥后，将其导出为 环境变量 in your terminal.
在 macOS 或 Linux 系统上导出环境变量
1
export OPENAI_API_KEY="your_api_key_here"

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

安装 OpenAI SDK 并运行 API 调用

要在 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 的功能与选项。

Responses 示例应用

开始使用 Responses API 进行构建。
文本生成与提示词

了解更多关于提示词、消息角色以及构建对话应用的知识。

充值以继续构建

前往账单
恭喜你成功运行了一个免费的测试 API 请求！开始构建具有更高限额的实际应用，并使用 我们的模型 来生成文本、音频、图像、视频等。

访问专为帮助你加速发布而设计的控制台功能：

聊天游乐场

构建和测试对话提示词，并将其嵌入到你的应用中。
智能体构建器

构建、部署和优化智能体工作流。

分析图像和文件

将图像 URL、上传的文件或 PDF 文档直接发送给模型，以提取文本、对内容进行分类或检测视觉元素。
分析图像内容
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
import OpenAI from "openai";
const client = new OpenAI();

const response = await client.responses.create({
    model: "gpt-5.5",
    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",
                },
            ],
        },
    ],
});

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

了解如何将图像输入给模型并提取图像中的含义。
文件输入指南

学习如何使用模型的文件输入功能并从文档中提取含义。

使用工具扩展模型

通过附加工具，让模型能够访问外部数据和函数 工具。使用内置工具（如网页搜索或文件搜索），或定义您自己的工具，以用于调用 API、运行代码或与第三方系统集成。
在响应中使用网络搜索
1
2
3
4
5
6
7
8
9
10
11
12
import OpenAI from "openai";
const client = new OpenAI();

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

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

了解网络搜索和文件搜索等强大的内置工具。
函数调用指南

学习如何使模型能够调用您的自定义代码。

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

使用服务器发送的 流式事件 以在结果生成时即时展示，或使用 Realtime API 构建交互式语音和多模态应用。

从 API 流式传输服务器发送事件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import { OpenAI } from "openai";
const client = new OpenAI();

const stream = await client.responses.create({
    model: "gpt-5.5",
    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 平台构建能够代表用户执行操作（例如 控制计算机 ）的 智能体。使用 Apps SDK 在后端创建编排逻辑。

构建语言分流智能体
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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 智能体。