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.
export OPENAI_API_KEY="your_api_key_here"setx 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:
npm install openaiUna vez instalado el SDK de OpenAI, crea un archivo llamado example.mjs y copia en él el código de ejemplo:
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.
Consulta el README de la biblioteca en GitHub para conocer más funciones y opciones del SDK.
Para acceder a la API de OpenAI desde Python, puedes usar el SDK oficial de OpenAI para Python. Para empezar, instala el SDK con pip:
pip install openaiUna vez instalado el SDK de OpenAI, crea un archivo llamado example.py y copia en él el código de ejemplo:
from openai import OpenAI
client = OpenAI()
response = client.responses.create(
model="gpt-6-astra",
input="Write a one-sentence bedtime story about a unicorn.",
)
print(response.output_text)Ejecuta el código con python example.py. En unos instantes, deberías ver el resultado de tu solicitud a la API.
Consulta el README de la biblioteca en GitHub para conocer más funciones y opciones del SDK.
En colaboración con Microsoft, OpenAI ofrece un cliente de API para C# con soporte oficial. Puedes instalarlo desde NuGet con la CLI de .NET.
dotnet add package OpenAI
Así puedes hacer una solicitud sencilla a la API de respuestas:
using OpenAI.Responses;
#pragma warning disable OPENAI001
string key = Environment.GetEnvironmentVariable("OPENAI_API_KEY")!;
ResponsesClient client = new(key);
ResponseResult response = await client.CreateResponseAsync(
"gpt-6-astra",
"Say 'this is a test.'"
);
Console.WriteLine($"[ASSISTANT]: {response.GetOutputText()}");OpenAI ofrece una biblioteca para usar la API desde Java. La biblioteca está en fase beta. Puedes agregar la dependencia de Maven con la siguiente configuración:
<dependency>
<groupId>com.openai</groupId>
<artifactId>openai-java</artifactId>
<version>4.103.0</version>
</dependency>Así puedes enviar una solicitud sencilla a la API de respuestas:
import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.responses.Response;
import com.openai.models.responses.ResponseCreateParams;
public class Main {
public static void main(String[] args) {
OpenAIClient client = OpenAIOkHttpClient.fromEnv();
ResponseCreateParams params =
ResponseCreateParams.builder().input("Say this is a test").model("gpt-6-astra").build();
Response response = client.responses().create(params);
response.output().stream()
.flatMap(item -> item.message().stream())
.flatMap(message -> message.content().stream())
.flatMap(content -> content.outputText().stream())
.forEach(outputText -> System.out.println(outputText.text()));
}
}Para saber más sobre cómo usar la API de OpenAI en Java, consulta el repositorio de GitHub en el siguiente enlace.
Consulta el archivo README de la biblioteca en GitHub para conocer más funciones y opciones del SDK.
Usa el SDK de Go para enviar tu primera solicitud a la API de respuestas.
package main
import (
"context"
"fmt"
"github.com/openai/openai-go/v3"
"github.com/openai/openai-go/v3/responses"
)
func main() {
client := openai.NewClient()
resp, err := client.Responses.New(context.TODO(), responses.ResponseNewParams{
Model: "gpt-6-astra",
Input: responses.ResponseNewParamsInputUnion{OfString: openai.String("Say this is a test")},
})
if err != nil {
panic(err.Error())
}
fmt.Println(resp.OutputText())
}Para saber más sobre cómo usar la API de OpenAI en Go, visita el repositorio de GitHub en el siguiente enlace.
Explora más funciones y opciones del SDK en el README del repositorio de la biblioteca en GitHub.
Para acceder a la API de OpenAI desde Ruby, puedes usar el SDK oficial de OpenAI para Ruby. Para empezar, agrega la gema a tu aplicación:
gem "openai"Una vez que hayas instalado el SDK de OpenAI, crea un archivo llamado example.rb y copia en él el código de ejemplo:
require "openai"
openai = OpenAI::Client.new
response = openai.responses.create(
model: "gpt-6-astra",
input: "Write a one-sentence bedtime story about a unicorn."
)
puts(response.output_text)Ejecuta el código con ruby example.rb. En unos instantes, deberías ver el resultado de tu solicitud a la API.
Consulta el README de la biblioteca en GitHub para conocer más funciones y opciones del SDK.
Para llamar a la API de OpenAI directamente desde tu terminal, instala openai, la herramienta de línea de comandos generada automáticamente:
brew install openai/tools/openaiLuego, envía una solicitud básica a la API desde tu shell:
openai responses create \
--model "gpt-6-astra" \
--input "Write a one-sentence bedtime story about a unicorn." \
--raw-output \
--transform 'output.#(type=="message").content.0.text'Usa la CLI para flujos de trabajo que puedas repetir en la terminal, como extraer datos estructurados de archivos, generar imágenes, sintetizar voz y componer llamadas a la API con herramientas de shell como jq.
Consulta la guía para conocer mejor los flujos de trabajo con la CLI y los patrones de comandos.
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.
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.
- Biblioteca cliente de Azure OpenAI para .NET
- Biblioteca cliente de Azure OpenAI para JavaScript
- Biblioteca cliente de Azure OpenAI para Java
- Biblioteca cliente de Azure OpenAI para Go
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
- AIProxySwift de Lou Zell
- OpenAIKit de dylanshine
- OpenAI de MacPaw
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