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.
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 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:
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 el comando equivalente para Deno o Bun). En unos momentos, deberías ver el resultado de tu solicitud a la API.
Descubre más capacidades y opciones del SDK en el README de la biblioteca en GitHub.
Para usar la API de OpenAI en Python, puedes usar el SDK oficial de OpenAI para Python. Para comenzar, instala el SDK con pip:
pip install openaiUna vez instalado el SDK de OpenAI, crea un archivo llamado example.py y copia el código de ejemplo en él:
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 momentos, deberías ver el resultado de tu solicitud a la API.
Descubre más capacidades y opciones del SDK en el README de la biblioteca en GitHub.
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
Una solicitud sencilla a la API Responses se vería así:
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 auxiliar para usar la API en el lenguaje de programación Java, actualmente en versión beta. Puedes incluir la dependencia de Maven con la siguiente configuración:
<dependency>
<groupId>com.openai</groupId>
<artifactId>openai-java</artifactId>
<version>4.58.0</version>
</dependency>Una solicitud sencilla a la API Responses se vería así:
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 obtener más información sobre cómo usar la API de OpenAI en Java, consulta el repositorio de GitHub en el enlace de abajo!
Descubre más capacidades y opciones del SDK en el README de la biblioteca en GitHub.
OpenAI ofrece una biblioteca auxiliar para la API en el lenguaje de programación Go, actualmente en beta. Puedes importar la biblioteca con el siguiente código:
import (
"github.com/openai/openai-go/v3" // imported as openai
)Una primera solicitud a la API Responses se vería así:
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 obtener más información sobre cómo usar la API de OpenAI en Go, consulta el repositorio de GitHub enlazado a continuación!
Descubre más capacidades y opciones del SDK en el README de la biblioteca en GitHub.
Para usar la API de OpenAI en Ruby, puedes usar el SDK oficial de OpenAI para Ruby. Para empezar, agrega la gema a tu aplicación:
gem "openai"Una vez instalado el SDK de OpenAI, crea un archivo llamado example.rb y copia el código de ejemplo en él:
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 momentos, deberías ver el resultado de tu solicitud a la API.
Descubre más capacidades y opciones del SDK en el README de la biblioteca en GitHub.
Para llamar a la API de OpenAI directamente desde tu terminal, instala la herramienta de línea de comandos generada openai:
brew install openai/tools/openaiLuego, ejecuta 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 repetibles en la terminal, como extraer datos estructurados de archivos, generar imágenes, crear voz y combinar llamadas a la API con herramientas de shell como jq.
Obtén más información sobre los flujos de trabajo de la CLI y los patrones de comandos.
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.
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.
- 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
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
- 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 de ingeniería de aprendizaje automático
- gym - biblioteca de aprendizaje por refuerzo
- swarm - repositorio de orquestación con fines educativos