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

SDK y CLI

Elige la forma adecuada de desarrollar con la API de OpenAI: un SDK para aplicaciones, la CLI para flujos de trabajo en la terminal o el Agents SDK para orquestación.

Esta página presenta las principales formas de desarrollar con la API de OpenAI: los SDK oficiales para el código de aplicaciones, la CLI de OpenAI para flujos de trabajo propios de la shell, el Agents SDK para orquestación o el cliente HTTP que prefieras.

Crea y exporta 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"

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

Instala un SDK oficial

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.

Usa el Agents SDK

Usa los SDK oficiales de OpenAI mencionados arriba para realizar solicitudes directas a la API. Usa el Agents SDK cuando tu aplicación necesite orquestación definida en código para agentes, herramientas, transferencias, medidas de protección, seguimiento o ejecución en un sandbox.

Si estás decidiendo entre solicitudes directas a la API y orquestación definida en código, consulta la comparación entre la API Responses y el Agents SDK.

Inicio rápido del Agents SDK

Crea tu primer agente con el Agents SDK.

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 las bibliotecas a continuación para aprender a usarlas con la API de OpenAI.


Bibliotecas de la comunidad

Las siguientes bibliotecas son desarrolladas y mantenidas por la comunidad de desarrolladores en general. También puedes seguir el repositorio de nuestra especificación OpenAPI en GitHub para recibir notificaciones oportunas cuando hagamos cambios en nuestra API.

Ten en cuenta que OpenAI no verifica el funcionamiento correcto 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 de ingeniería de aprendizaje automático
  • gym - biblioteca de aprendizaje por refuerzo
  • swarm - repositorio de orquestación con fines educativos