For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Navegação principal

Início rápido para desenvolvedores

Dê seus primeiros passos com a API da OpenAI.

A API da OpenAI oferece uma interface consistente para modelos de IA de última geração para geração de texto, processamento de linguagem natural, visão computacional e muito mais. Comece criando uma chave de API e fazendo sua primeira chamada à API. Descubra como gerar texto, analisar imagens, criar agentes e muito mais.

Crie e exporte uma chave de API

Criar uma chave de API

Antes de começar, crie uma chave de API no painel. Você vai usá-la para acessar a API com segurança. Armazene a chave em um local seguro, como um arquivo .zshrc ou outro arquivo de texto no seu computador. Depois de gerar uma chave de API, exporte-a como uma variável de ambiente no seu terminal.

Exporte uma variável de ambiente em sistemas macOS ou Linux
export OPENAI_API_KEY="your_api_key_here"

Cada OpenAI SDK lê automaticamente sua chave de API do ambiente do sistema.

Instale o OpenAI SDK e faça uma chamada à API

Para usar a API da OpenAI em ambientes JavaScript no servidor, como Node.js, Deno ou Bun, você pode usar o OpenAI SDK oficial para TypeScript e JavaScript. Comece instalando o SDK com npm ou com seu gerenciador de pacotes preferido:

Instale o OpenAI SDK com npm
npm install openai

Com o OpenAI SDK instalado, crie um arquivo chamado example.mjs e copie o código de exemplo para ele:

Teste uma requisição básica à API
import OpenAI from "openai";
const client = new OpenAI();

const response = await client.responses.create({
  model: "gpt-6-astra",
  input: "Write a one-sentence bedtime story about a unicorn.",
});

console.log(response.output_text);

Execute o código com node example.mjs (ou o comando equivalente para Deno ou Bun). Em alguns instantes, você deverá ver o resultado da sua requisição à API.

Saiba mais no GitHub

Conheça mais capacidades e opções do SDK no README da biblioteca no GitHub.

Aplicativo inicial da Responses

Comece a desenvolver com a Responses API.

Geração de texto e criação de prompts

Saiba mais sobre criação de prompts, papéis das mensagens e desenvolvimento de aplicativos de conversação.

Adicione créditos para continuar desenvolvendo

Ir para faturamento

Parabéns por fazer uma requisição de teste gratuita à API! Comece a desenvolver aplicativos reais com limites mais altos e use nossos modelos para gerar texto, áudio, imagens, vídeos e muito mais.

Explore ferramentas e documentação que ajudam você a lançar seus projetos mais rápido:

Playground de chat

Crie e teste prompts de conversação e incorpore-os ao seu aplicativo.

Crie agentes

Use o Agents SDK para criar, executar e observar fluxos de trabalho de agentes.

Analise imagens e arquivos

Envie URLs de imagens, arquivos carregados ou documentos PDF diretamente ao modelo para extrair texto, classificar conteúdo ou detectar elementos visuais.

Analise o conteúdo de uma imagem
import OpenAI from "openai";
const client = new OpenAI();

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

console.log(response.output_text);
Guia de entradas de imagem

Aprenda a usar imagens como entrada para o modelo e a extrair significado delas.

Guia de arquivos de entrada

Aprenda a usar arquivos como entrada para o modelo e a extrair significado de documentos.

Amplie os recursos do modelo com ferramentas

Dê ao modelo acesso a dados e funções externos adicionando ferramentas. Use ferramentas integradas, como pesquisa na Web ou pesquisa de arquivos, ou defina suas próprias ferramentas para chamar APIs, executar código ou integrar sistemas de terceiros.

Use a pesquisa na Web em uma resposta
import OpenAI from "openai";
const client = new OpenAI();

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

console.log(response.output_text);
Use ferramentas integradas

Conheça ferramentas integradas poderosas, como pesquisa na Web e pesquisa de arquivos.

Guia de chamada de função

Aprenda a permitir que o modelo chame seu próprio código personalizado.

Transmita respostas por streaming e crie aplicativos em tempo real

Use eventos de streaming enviados pelo servidor para exibir resultados à medida que são gerados, ou use a Realtime API para aplicativos de voz interativos e aplicativos com entradas de texto, áudio e imagem.

Transmita por streaming os eventos enviados pelo servidor da API
import { OpenAI } from "openai";
const client = new OpenAI();

const stream = await client.responses.create({
  model: "gpt-6-astra",
  input: [
    {
      role: "user",
      content: "Say 'double bubble bath' ten times fast.",
    },
  ],
  stream: true,
});

for await (const event of stream) {
  console.log(event);
}
Use eventos de streaming

Use eventos enviados pelo servidor para transmitir rapidamente as respostas do modelo aos usuários por streaming.

Primeiros passos com a Realtime API

Use WebRTC ou WebSockets para criar aplicativos de IA de fala para fala extremamente rápidos.

Crie agentes

Use a plataforma da OpenAI para criar agentes capazes de executar ações, como controlar computadores, em nome dos seus usuários. Use o Agents SDK para criar a lógica de orquestração no seu servidor.

Crie um agente de triagem por idioma
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);
Crie agentes capazes de executar ações

Aprenda a usar a plataforma da OpenAI para criar agentes de IA poderosos e capazes.