SDK OpenAI para JavaScript (Node.js): guia completo com exemplos

Bem-vindo ao guia mais completo sobre o uso do SDK oficial da OpenAI para JavaScript no ambiente Node.js. Este artigo foi criado especialmente para o portal educacional PythonLib, com o objetivo de ajudar desenvolvedores de todos os níveis a integrar de forma rápida e eficiente os recursos de inteligência artificial da OpenAI em suas aplicações web, bots e soluções de backend.

1. O que é e para que serve

O SDK OpenAI para JavaScript é a biblioteca oficial fornecida pela OpenAI para interagir com sua API a partir de aplicações escritas em JavaScript (Node.js). Ela funciona como uma camada de abstração sobre a REST API, cuidando de todo o trabalho repetitivo: construção de requisições HTTP, processamento de respostas, gerenciamento de autenticação, tentativas automáticas em caso de erros de rede e transmissão de dados em streaming. Em vez de escrever requisições fetch manualmente, processar JSON e gerenciar tokens, você obtém uma interface intuitiva com métodos cujos nomes são autoexplicativos — chat.completions.create(), embeddings.create(), images.generate() e outros.

Para que serve essa biblioteca? Primeiro, ela acelera drasticamente o desenvolvimento. Em vez de dezenas de linhas de código para uma única requisição ao ChatGPT, você escreve de 3 a 5 linhas. Segundo, o SDK lida automaticamente com recursos complexos como streaming — quando a resposta do modelo chega em partes, algo essencial para criar interfaces de chat que exibem texto em tempo real. Terceiro, a biblioteca oferece suporte nativo a TypeScript, fornecendo tipagem completa para todas as requisições e respostas, permitindo capturar erros durante a escrita do código, não na execução. Por fim, é uma ferramenta oficial que é atualizada junto com a API, garantindo acesso aos modelos e funcionalidades mais recentes, como GPT-4o, DALL-E 3, Whisper e TTS.

Esta biblioteca é ideal para criar chatbots, assistentes inteligentes, sistemas de análise de texto, geração de conteúdo, tradução, sumarização, além de integração com frameworks como Express.js, Next.js ou Telegram Bot API. Se você programa em Node.js e quer adicionar "inteligência" da OpenAI ao seu projeto, este SDK é a escolha certa.

2. Instalação

A instalação da biblioteca é feita através do gerenciador de pacotes npm. Certifique-se de ter o Node.js versão 18 ou superior instalado (recomenda-se a 20 LTS).

Comando exato para instalação:

npm install openai

Se você usa yarn:

yarn add openai

Após a instalação, você precisará de uma chave de API da OpenAI. Obtenha-a na página platform.openai.com/api-keys. A chave deve ser armazenada com segurança, por exemplo, em uma variável de ambiente chamada OPENAI_API_KEY.

3. Início rápido — exemplo mínimo funcional

Vamos escrever um script simples que faz uma pergunta ao modelo GPT-4o e exibe a resposta. Crie um arquivo quickstart.mjs (usando módulos ES) ou quickstart.js (para CommonJS).

// quickstart.mjs — usando módulos ES
import OpenAI from "openai";

const openai = new OpenAI({
  apiKey: process.env["OPENAI_API_KEY"], // chave da variável de ambiente
});

async function main() {
  const completion = await openai.chat.completions.create({
    model: "gpt-4o",
    messages: [
      { role: "system", content: "Você é um assistente útil." },
      { role: "user", content: "Escreva uma saudação curta em português." },
    ],
  });

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

main();

Execute o script:

export OPENAI_API_KEY="sk-..." # Linux/macOS
set OPENAI_API_KEY="sk-..."