openai-node

环境要求

• Node.js 运行环境（README 未限定版本，建议用 LTS）
• npm 包管理器
• 一个可用的 API Key，通过环境变量 OPENAI_API_KEY 提供
• 可选：Deno 运行时可从 npm 直接导入该包

安装与启动步骤

1. 1确认运行环境

   确认本机已安装 Node.js 与 npm，后续安装和示例都在 Node 环境中运行。

   node -v
   npm -v

   复制

2. 2初始化项目目录

   新建一个空目录并生成 package.json，作为使用 SDK 的工程根目录。

   mkdir openai-demo && cd openai-demo && npm init -y

   复制

3. 3安装 openai 包

   README 给出的唯一安装方式，在项目目录下执行即可完成依赖安装。

   npm install openai

   复制

4. 4配置 API Key

   SDK 默认读取环境变量 OPENAI_API_KEY，该设置只对当前终端会话生效。

   export OPENAI_API_KEY=sk-xxxxxxxx

   复制

5. 5编写调用脚本

   按 README 示例创建 index.mjs，调用 Responses API 并打印返回文本。

   cat > index.mjs <<'EOF'
   import OpenAI from 'openai';
   
   const client = new OpenAI({
     apiKey: process.env['OPENAI_API_KEY'],
   });
   
   const response = await client.responses.create({
     model: 'gpt-5.5',
     instructions: 'You are a coding assistant that talks like a pirate',
     input: 'Are semicolons optional in JavaScript?',
   });
   
   console.log(response.output_text);
   EOF

   复制

6. 6运行脚本验证

   执行脚本，终端输出模型生成的文本即代表安装与调用链路正常。

   node index.mjs

   复制

7. 7Deno 方式导入

   使用 Deno 时无需 npm 安装，直接从 npm 说明符导入该包即可。

   import OpenAI from 'npm:openai';

   复制

关键配置

如何确认成功

运行 node index.mjs 后终端打印出模型返回的文本（response.output_text），即表示安装与调用成功。

常见问题

注意事项

• 不要把 API Key 写死在代码里或提交到 Git 仓库，统一用环境变量注入。
• README 未限定 Node.js 最低版本，建议使用官方 LTS 版本以避免兼容问题。
• 更多接口用法见仓库中的 api.md 与 examples 目录，不要凭猜测传参。