For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Navegación principal

Inicio rápido para desarrolladores

Da tus primeros pasos con la API de OpenAI.

La API de OpenAI ofrece una interfaz uniforme para acceder a modelos de IA de última generación para la generación de texto, el procesamiento del lenguaje natural, la visión por computadora y mucho más. Para empezar, crea una clave de API y realiza tu primera llamada a la API. Descubre cómo generar texto, analizar imágenes, crear agentes y mucho más.

Crea y exporta una clave de API

Crea una clave de API

Antes de comenzar, crea una clave de API en el panel, que usarás para acceder a la API de forma segura. Guarda la clave en un lugar seguro, como un archivo .zshrc u otro archivo de texto en tu computadora. Una vez que hayas generado una clave de API, expórtala como una variable de entorno en tu terminal.

Exporta una variable de entorno en sistemas macOS o Linux
export OPENAI_API_KEY="your_api_key_here"

Cada SDK de OpenAI lee automáticamente tu clave de API del entorno del sistema.

Instala el SDK de OpenAI y realiza una llamada a la API

Para usar la API de OpenAI en entornos JavaScript del lado del servidor como Node.js, Deno o Bun, puedes usar el SDK oficial de OpenAI para TypeScript y JavaScript. Para empezar, instala el SDK con npm o tu gestor de paquetes preferido:

Instala el SDK de OpenAI con npm
npm install openai

Una vez instalado el SDK de OpenAI, crea un archivo llamado example.mjs y copia en él el código de ejemplo:

Prueba una solicitud básica a la 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);

Ejecuta el código con node example.mjs (o el comando equivalente para Deno o Bun). En unos momentos, deberías ver el resultado de tu solicitud a la API.

Obtén más información en GitHub

Descubre más capacidades y opciones del SDK en el README de la biblioteca en GitHub.

Aplicación inicial de Responses

Empieza a desarrollar con la API Responses.

Generación de texto y diseño de prompts

Aprende más sobre el diseño de prompts, los roles de los mensajes y la creación de aplicaciones conversacionales.

Agrega créditos para seguir desarrollando

Ir a facturación

¡Felicidades por realizar una solicitud de prueba gratuita a la API! Empieza a desarrollar aplicaciones reales con límites más altos y usa nuestros modelos para generar texto, audio, imágenes, videos y mucho más.

Explora herramientas y documentación diseñadas para ayudarte a lanzar tus aplicaciones más rápido:

Playground de chat

Crea y prueba prompts conversacionales e intégralos en tu aplicación.

Crea agentes

Usa el Agents SDK para crear, ejecutar y observar flujos de trabajo de agentes.

Analiza imágenes y archivos

Envía URLs de imágenes, archivos cargados o documentos PDF directamente al modelo para extraer texto, clasificar contenido o detectar elementos visuales.

Analiza el contenido de una imagen
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);
Guía de imágenes de entrada

Aprende a proporcionar imágenes de entrada al modelo y a interpretar su contenido.

Guía de archivos de entrada

Aprende a proporcionar archivos de entrada al modelo y a interpretar el contenido de los documentos.

Amplía las capacidades del modelo con herramientas

Dale al modelo acceso a datos y funciones externos mediante herramientas. Usa herramientas integradas como la búsqueda web o la búsqueda de archivos, o define tus propias herramientas para llamar a APIs, ejecutar código o integrar sistemas de terceros.

Usa la búsqueda web en una respuesta
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);
Usa herramientas integradas

Conoce potentes herramientas integradas como la búsqueda web y la búsqueda de archivos.

Guía de llamada a funciones

Aprende a habilitar el modelo para que llame a tu propio código personalizado.

Transmite respuestas mediante streaming y crea aplicaciones en tiempo real

Usa eventos de streaming enviados por el servidor para mostrar los resultados a medida que se generan, o usa la Realtime API para aplicaciones de voz interactivas y aplicaciones con entradas de texto, audio e imágenes.

Transmite mediante streaming los eventos enviados por el servidor desde la 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);
}
Usa eventos de streaming

Usa eventos enviados por el servidor para transmitir rápidamente las respuestas del modelo a los usuarios mediante streaming.

Primeros pasos con la Realtime API

Usa WebRTC o WebSockets para aplicaciones de IA de voz a voz ultrarrápidas.

Crea agentes

Usa la plataforma de OpenAI para crear agentes capaces de realizar acciones, como controlar computadoras, en nombre de tus usuarios. Usa el Agents SDK para crear la lógica de orquestación en tu servidor.

Crea un agente de clasificación 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);
Crea agentes que puedan realizar acciones

Aprende a usar la plataforma de OpenAI para crear agentes de IA potentes y capaces.