Guía de Inicio Rápido de la API de Ollama

Configuración de URL Base y Autenticación

Configura tu cliente para apuntar a nuestro endpoint alojado. Establece el base_url para https://api.apiollama.com/v1 y proporciona tu clave en el Authorization header. La autenticación utiliza el estándar Bearer esquema. Puedes generar una clave mediante Google o correo electrónico en el panel. El sistema crea una clave activa por cuenta.

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

Mantén tu clave segura. Si necesitas una clave nueva, genera una en el panel y la antigua se vuelve inactiva inmediatamente. No se requiere número de teléfono para la configuración. Esta configuración funciona con cualquier cliente compatible con OpenAI.

POST /v1/chat/completions: Envío de Solicitudes

Envía tu primera solicitud de finalización de chat usando el punto de conexión estándar. Especifica el ID del modelo como uncensored en el cuerpo de la solicitud. La API acepta matrices de mensajes estándar que contienen roles de sistema, usuario y asistente. Esto funciona con cualquier SDK que soporte el formato de OpenAI. Asegúrate de incluir el model field in every request.

Copyfrom openai import OpenAI

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

Las solicitudes se procesan a través de nuestros servidores. El modelo responde con texto generado basado en su prompt. Puede ajustar parámetros como temperature o top_p para controlar la aleatoriedad. El sistema devuelve un objeto de respuesta completo que contiene el contenido generado.

GET /v1/models: Listado de modelos disponibles

Consulta el endpoint de modelos para verificar las opciones disponibles. Envía una solicitud GET a /v1/models para listar los modelos alojados. La respuesta incluye el id field set to uncensored. Este endpoint confirma que tu clave de API tiene permisos válidos. Devuelve metadatos sobre la configuración del modelo.

Copyimport OpenAI from "openai";

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

Utiliza esta llamada para depurar problemas de conexión. Si el endpoint devuelve un error, verifica tu cabecera de autenticación. El endpoint proporciona una lista simple de modelos disponibles. Puedes verificar el estado del servicio sin enviar una solicitud de chat completa.

Respuestas en streaming con Server-Sent Events

Habilita el streaming estableciendo el stream parámetro a true. La API devuelve Server-Sent Events (SSE) para la entrega de tokens en tiempo real. Cada fragmento contiene actualizaciones de contenido parcial. El último fragmento incluye las estadísticas completas de uso de tokens. Esto reduce la latencia percibida para respuestas largas.

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)

Maneja el flujo SSE en el código de tu cliente. Procesa cada evento a medida que llega. El último evento contiene el usage objeto con conteos de tokens de entrada y salida. El streaming funciona con todos los parámetros soportados. Proporciona retroalimentación inmediata para aplicaciones interactivas.

Parámetros de configuración: Temperatura, Top-p y más

Ajustar el comportamiento de generación utilizando parámetros estándar. Establecer temperature para aleatoriedad y top_p para muestreo por núcleo. Usa stop secuencias para detener la generación temprano. La seed el parámetro garantiza resultados reproducibles. También puedes establecer presence_penalty y frequency_penalty para el control del estilo.

El modo JSON está disponible a través de response_format. Configura esto como json_object para salidas estructuradas. El modelo se adhiere al formato especificado. Estos parámetros se aplican a todas las solicitudes. Úsalos para ajustar el estilo de respuesta.

Gestión de errores y registro de uso de tokens

Gestiona los errores HTTP comunes en tu aplicación. Un estado 401 indica una clave API inválida. Un estado 402 significa que tu crédito prepagado se ha agotado. Un estado 429 indica que has superado el límite de frecuencia. Comprueba el cuerpo de la respuesta para obtener mensajes de error detallados. Las denegaciones por política de contenido son gratuitas.

La ventana de contexto admite 100.000 tokens en total. La salida está limitada a 16.000 tokens por solicitud. La salida predeterminada es de 2.048 tokens si max_tokens no está establecido. El uso de tokens se informa en el último fragmento del stream. Los errores no consumen crédito.