OpenAI SDK for JavaScript (Node.js): Complete Guide with Examples

Welcome to the most comprehensive guide on using the official OpenAI SDK for JavaScript in the Node.js environment. This article is created specifically for the PythonLib educational portal to help developers of all levels quickly and effectively integrate OpenAI's artificial intelligence capabilities into their web applications, bots, and server-side solutions.

1. What It Is and Why You Need It

The OpenAI SDK for JavaScript is the official library provided by OpenAI for interacting with their API from JavaScript (Node.js) applications. It's a convenient wrapper around the REST API that handles all the heavy lifting: forming HTTP requests, processing responses, managing authentication, retrying on network errors, and streaming data. Instead of manually writing fetch requests, handling JSON, and managing tokens, you get an intuitive interface with self-explanatory methods like chat.completions.create(), embeddings.create(), images.generate(), and more.

Why do you need this library? First, it dramatically speeds up development. Instead of dozens of lines of code for a single ChatGPT request, you write 3-5 lines. Second, the SDK automatically handles complex features like streaming — where the model's response arrives in chunks, which is critical for building chat interfaces with real-time text display. Third, the library supports TypeScript out of the box, providing full typing for all requests and responses, letting you catch errors at coding time rather than runtime. Finally, it's the official tool that updates alongside the API, so you'll always have access to the latest models and features like GPT-4o, DALL-E 3, Whisper, and TTS.

This library is perfect for building chatbots, intelligent assistants, text analysis systems, content generation tools, translation services, summarization apps, and integrations with frameworks like Express.js, Next.js, or the Telegram Bot API. If you're coding in Node.js and want to add OpenAI's "brains" to your project — this SDK is your go-to choice.

2. Installation

Install the library using the standard npm package manager. Make sure you have Node.js version 18 or higher installed (20 LTS recommended).

Exact installation command:

npm install openai

If you're using yarn:

yarn add openai

After installation, you'll need an API key from OpenAI. Get yours at platform.openai.com/api-keys. Store the key securely, for example, in the OPENAI_API_KEY environment variable.

3. Quick Start — Minimal Working Example

Let's write a simple script that asks the GPT-4o model a question and prints the response. Create a file called quickstart.mjs (using ES modules) or quickstart.js (for CommonJS).

// quickstart.mjs — using ES modules
import OpenAI from "openai";

const openai = new OpenAI({
  apiKey: process.env["OPENAI_API_KEY"], // key from environment variable
});

async function main() {
  const completion = await openai.chat.completions.create({
    model: "gpt-4o",
    messages: [
      { role: "system", content: "You are a helpful assistant." },
      { role: "user", content: "Write a short greeting in English." },
    ],
  });

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

main();

Run the script:

export OPENAI_API_KEY="sk-..." # Linux/macOS
set OPENAI_API_KEY="sk-..."    # Windows
node quickstart.mjs