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
Theme

SDK y CLI

Elige cómo desarrollar con la API de OpenAI según lo que necesites: un SDK para tus aplicaciones, la CLI para trabajar desde la terminal o el SDK de agentes para la orquestación.

Esta página presenta las principales opciones para desarrollar con la API de OpenAI: los SDK oficiales para usar en el código de tus aplicaciones, la CLI de OpenAI para trabajar directamente desde el shell, el SDK de agentes para la orquestación o el cliente HTTP que prefieras.

Crea y exporta una clave de API

Antes de empezar, crea una clave de API en el panel de control. La 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 la clave de API, expórtala como variable de entorno en tu terminal.

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

Los SDK de OpenAI están configurados para leer automáticamente tu clave de API del entorno del sistema.

Instala un SDK oficial

Para acceder a la API de OpenAI desde entornos de 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 con el gestor de paquetes que prefieras:

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 con el comando equivalente para Deno o Bun). En unos instantes deberías ver el resultado de tu solicitud a la API.

Más información en GitHub

Consulta el README de la biblioteca en GitHub para conocer más funciones y opciones del SDK.

Usa el SDK de agentes

Usa los SDK oficiales de OpenAI de la sección anterior para enviar solicitudes directamente a la API. Usa el SDK de agentes cuando necesites definir en el código de tu aplicación cómo coordinar agentes y herramientas, transferir el control entre agentes, aplicar mecanismos de protección, registrar trazas o ejecutar código en un sandbox.

Si estás decidiendo entre enviar solicitudes directamente a la API o definir la orquestación en código, consulta la comparación entre la API de Responses y el SDK de agentes.

Guía de inicio rápido del SDK de agentes

Crea tu primer agente con el SDK de agentes.

Bibliotecas de Azure OpenAI

El equipo de Azure de Microsoft mantiene bibliotecas compatibles tanto con la API de OpenAI como con los servicios de Azure OpenAI. Consulta la documentación de estas bibliotecas para saber cómo usarlas con la API de OpenAI.


Bibliotecas de la comunidad

La comunidad de desarrolladores crea y mantiene las siguientes bibliotecas. También puedes seguir en GitHub el repositorio de nuestra especificación OpenAPI para recibir avisos cuando hagamos cambios en nuestra API.

Ten en cuenta que OpenAI no verifica el correcto funcionamiento ni la seguridad de estos proyectos. ¡Úsalos bajo tu propia responsabilidad!

Clojure

Dart/Flutter

Delphi

Elixir

Kotlin

PHP

Rust

Scala

Swift

Unity

Unreal Engine

Otros repositorios de OpenAI

  • tiktoken - conteo de tokens
  • simple-evals - biblioteca sencilla de evaluación
  • mle-bench - biblioteca para evaluar agentes que realizan tareas de ingeniería de aprendizaje automático
  • gym - biblioteca de aprendizaje por refuerzo
  • swarm - repositorio educativo sobre orquestación