Documentación de la API de Ollama: Guía de Inicio Rápido
Esta guía proporciona los detalles concretos de nuestra API compatible con OpenAI, permitiéndote sustituir nuestro modelo sin censura sin cambiar tu código de cliente existente.
URL Base y Autenticación
La URL base es HTTPS://api.ollamaapidocs.com/v1. Pasa tu clave en el encabezado Authorization estándar.
curl https://api.ollamaapidocs.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "List installed models in the local directory"}]
}'Endpoint Chat Completions
Envía solicitudes POST a /v1/chat/completions con el modelo configurado como uncensored.
from openai import OpenAI
client = OpenAI(base_url="https://api.ollamaapidocs.com/v1", api_key="YOUR_KEY")
resp = client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)Soporte de streaming y herramientas
Activa la transmisión estableciendo stream en true. La API devuelve tokens mediante Eventos Enviados por Servidor y admite la llamada de funciones.
stream = client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "Tell the story in second person."}],
stream=True,
)
for chunk in stream:
if chunk.choices and chunk.choices[0].delta.content:
print(chunk.choices[0].delta.content, end="", flush=True)Modo JSON y parámetros
Usa response_format json_object para una salida JSON estricta. También puedes ajustar la temperatura, top_p y secuencias de parada.
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.ollamaapidocs.com/v1", apiKey: process.env.API_KEY });
const resp = await client.chat.completions.create({
model: "uncensored",
messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);Límites de velocidad y restricciones
El límite es de 300 solicitudes por minuto por clave. Cada solicitud admite una ventana de contexto de 100.000 tokens.
curl https://api.ollamaapidocs.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "List installed models in the local directory"}]
}'Errores y Ventana de Contexto
Gestiona los errores 401 para claves inválidas, 402 por falta de crédito y 429 por límites de tasa. El modelo admite una ventana de contexto de 100,000 tokens.
from openai import OpenAI
client = OpenAI(base_url="https://api.ollamaapidocs.com/v1", api_key="YOUR_KEY")
resp = client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)Preguntas frecuentes
¿Cuáles son los documentos de la API de ollama para este servicio?
Esta guía cubre la URL base, la autenticación y los endpoints de nuestra API alojada. Te permite utilizar los SDK estándar de OpenAI con nuestro modelo sin censura.
¿Cómo manejo las respuestas en streaming?
Establece el parámetro stream a true en tu solicitud. La API devuelve tokens mediante Server-Sent Events, lo que permite un procesamiento en tiempo real.
¿Qué sucede si excedo el límite de velocidad?
Recibirás un código de estado 429. El límite es de 300 solicitudes por minuto por clave, con un máximo de 8 solicitudes concurrentes.
Genera tu clave de API
Regístrate, copia tu clave y actualiza la URL base. Eso es todo lo que necesitas para empezar.
