开发人员快速入门

了解如何发出您的第一个 API 请求。

OpenAI API 为最先进的 AI 模型提供了一个简单的接口，用于自然语言处理、图像生成、语义搜索和语音识别。按照本指南了解如何生成对自然语言提示的类似人类的响应，创建用于语义搜索的向量嵌入，以及从文本描述生成图像。source

创建和导出 API 密钥

在此处的控制面板中创建一个 API 密钥，您将使用该密钥安全地访问 API。将密钥存储在安全的位置，例如.zshrc文件或计算机上的其他文本文件。生成 API 密钥后，将其作为环境变量导出到终端中。source

在 macOS 或 Linux 系统上导出环境变量

1
export OPENAI_API_KEY="your_api_key_here"

发出您的第一个 API 请求

将 OpenAI API 密钥导出为环境变量后，您就可以发出第一个 API 请求了。您可以直接将 REST API 与您选择的 HTTP 客户端一起使用，也可以使用我们的官方 SDK 之一，如下所示。source

要在 Node.js、Deno 或 Bun 等服务器端 JavaScript 环境中使用 OpenAI API，您可以使用适用于 TypeScript 和 JavaScript 的官方 OpenAI SDK。首先使用 npm 或首选包管理器安装 SDK：source

使用 npm 安装 OpenAI SDK

1
npm install openai

安装 OpenAI SDK 后，创建一个名为example.mjs，然后将以下示例之一复制到其中：source

创建对提示的类似人类的响应

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
import OpenAI from "openai";
const openai = new OpenAI();

const completion = await openai.chat.completions.create({
    model: "gpt-4o-mini",
    messages: [
        { role: "system", content: "You are a helpful assistant." },
        {
            role: "user",
            content: "Write a haiku about recursion in programming.",
        },
    ],
});

console.log(completion.choices[0].message);