Documentación de la API de Ollama: Referencia de Endpoints

URL Base y Autenticación

La URL base para todas las solicitudes es https://api.ollamaapidocumentation.com/v1. Autentícate utilizando un token bearer pasado en el Authorization header. Tu clave se genera en el panel de control y funciona inmediatamente.

• Utiliza los SDK oficiales de OpenAI o cualquier cliente compatible.
• Establece la URL base en el valor anterior.
• Incluya su clave API en el encabezado.

La autenticación es estricta. Si falta la clave o es inválida, la API devuelve un error 401. Esto garantiza que tu uso se rastree con precisión para la facturación.

Endpoint Chat Completions: POST /v1/chat/completions

Envía mensajes al modelo a través de POST /v1/chat/completions. El endpoint acepta un cuerpo JSON con un model field set to "uncensored" and a messages array.

Este extremo maneja generación de texto. No admite imágenes, audio ni video. Puedes transmitir respuestas o esperar el resultado completo.

Errores como 402 indican crédito insuficiente. Las solicitudes se cobran por el uso real de tokens. Las denegaciones por crédito son gratuitas.

Listado de Modelos: GET /v1/models

Recupera los modelos disponibles mediante GET /v1/models. Esto devuelve una lista de objetos de modelo. El único ID de modelo disponible es "uncensored".

Este extremo ayuda a verificar la conectividad. Confirma que la URL base es correcta. También muestra el nombre del modelo y el tipo de objeto.

Utilice esto para depurar problemas de conexión antes de enviar cargas pesadas.

Parámetros: Temperatura, Top P y Seed

Controla la generación con temperature, top_p, y seed. El seed parameter asegura salidas deterministas. Úsalo para depuración o resultados consistentes.

Establecer temperature entre 0 y 2. Los valores más bajos hacen que las respuestas sean más predecibles. Los valores más altos aumentan la aleatoriedad. El top_p el parámetro filtra los tokens por probabilidad acumulada.

Estos parámetros funcionan exactamente igual que la API de OpenAI. Puedes combinarlos para un control preciso del estilo.

Respuestas en streaming y uso de tokens

Habilita la transmisión estableciendo stream: true. La API devuelve Eventos Enviados por Servidor (SSE). Cada fragmento contiene texto parcial.

El último fragmento incluye las estadísticas de uso de tokens. Esto te permite calcular los costos con precisión. Puedes procesar los tokens a medida que llegan.

El streaming reduce la latencia percibida. Es ideal para interfaces de chat. El servidor envía datos hasta que la respuesta esté completa.

Límites, Errores y Ventana de Contexto

La ventana de contexto es de 100.000 tokens. Esto incluye tanto la entrada como la salida. Puedes generar hasta 16.000 tokens por solicitud. La salida máxima predeterminada es de 2.048 tokens.

Los límites de tasa son de 300 solicitudes por minuto. Puedes tener 8 solicitudes concurrentes. El tamaño del cuerpo de la solicitud está limitado a 8 MB.

Los errores incluyen 401 para claves inválidas y 429 para límites de tasa. Los errores de crédito devuelven 402. Estos errores son claros y accionables.

cURL

Copycurl https://api.ollamaapidocumentation.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list files in the current directory"}]
  }'

Python

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.ollamaapidocumentation.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)

Node.js

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.ollamaapidocumentation.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);

Transmisión

Copystream = 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)