API Documentación

URL Base y Autenticación

La API vive en https://api.ollamaapidoc.com/v1. Autentícate utilizando un token Bearer en el Authorization header. Genera tu clave al instante con Google o correo electrónico en el panel de control. No se requiere número de teléfono. La clave funciona con SDK estándar de OpenAI configurando la URL base.

Tu Primera Solicitud

Envía una solicitud POST a /v1/chat/completions con el ID del modelo uncensored. Este endpoint maneja entrada de texto y salida de texto. Admite streaming, modo JSON y llamada de funciones. Puedes probar la conectividad sin gastar crédito verificando primero el endpoint de modelos.

Copycurl https://api.ollamaapidoc.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list all installed models"}]
  }'

La respuesta devuelve el formato estándar de OpenAI. Los errores devuelven los códigos HTTP apropiados. Verifica el cuerpo para error detalles si algo falla. Las respuestas en streaming utilizan Server-Sent Events.

Integración del SDK de Python

Instala la biblioteca oficial de OpenAI. Configura el cliente con tu URL base y clave de API. Llama al endpoint de completaciones de chat. El código permanece idéntico al uso estándar de OpenAI. Esto garantiza una migración fácil para proyectos existentes. Puedes ajustar parámetros como temperatura y top_p directamente en la llamada.

Copyfrom openai import OpenAI

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

Maneja excepciones por límites de velocidad o claves inválidas. La biblioteca transmite tokens si configuras stream como true. Este enfoque mantiene tu base de código limpia y compatible.

Configuración del SDK de Node.js

Utiliza el openai paquete npm. Inicializa el cliente con la URL base personalizada. Pasa tu clave API. La sintaxis refleja el ejemplo de Python. Esta consistencia reduce el tiempo de depuración. Puedes enviar múltiples mensajes en un array de historial de conversación.

Copyimport OpenAI from "openai";

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

Analiza la respuesta con cuidado. La API devuelve JSON estructurado. El manejo de errores es crucial para aplicaciones en producción. Captura los errores de red y los errores específicos de la API por separado. Esto asegura que tu aplicación se mantenga receptiva durante picos de tráfico.

Streaming y Modo JSON

Habilita el streaming estableciendo el stream parámetro a true. La API envía tokens mediante Server-Sent Events. Recibes respuestas parciales en tiempo real. Esto mejora la experiencia del usuario para salidas largas. También puedes forzar una salida JSON usando response_format. Esto es útil para la extracción de datos estructurados.

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)

La llamada de funciones funciona de manera similar. Define herramientas en tu solicitud. El modelo devuelve llamadas de herramientas. Analiza estas llamadas en tu código. Ejecútalas y alimenta los resultados de vuelta al modelo. Este bucle permite flujos de trabajo complejos.

Límites, Errores y Contexto

La ventana de contexto es de 100.000 tokens. La salida máxima es de 16.000 tokens por solicitud. Los errores incluyen 401 para claves inválidas y 402 por crédito insuficiente. Los límites de velocidad se fijan en 300 solicitudes por minuto. Maneja estos casos de forma elegante en tu aplicación. La API nunca utiliza tus prompts para entrenamiento. La privacidad se mantiene. El crédito no caduca.