Documentación de la API

Inicio rápido para tu primera solicitud

Empieza a generar texto de inmediato apuntando tu cliente a nuestra URL base y autenticándote con una clave de API generada. La interfaz sigue convenciones estándar, por lo que puedes usar SDKs existentes sin aprender un nuevo protocolo. Enviarás prompts a la uncensored modelo y recibe respuestas de texto que no aplican los filtros de contenido típicos para uso adulto legal.

Configura la URL base y la clave

Configura tus variables de entorno para enrutar las solicitudes a nuestro punto final específico. Reemplaza la clave de marcador de posición con la generada durante el registro. Esto asegura que todas las llamadas subsiguientes utilicen la instancia correcta del modelo uncensored.

• URL base: https://api.nsfwlocalllm.com/v1
• Cabecera de autenticación: Authorization: Bearer YOUR_API_KEY

Puedes verificar que tu clave funciona comprobando el punto de conexión de modelos. Una clave válida devuelve el ID del modelo disponible inmediatamente.

Envía una solicitud de finalización de chat

Envía una carga útil estándar de completación de chat para generar texto. El sistema procesa tu entrada y devuelve la respuesta del modelo. Utiliza uncensored ID del modelo para asegurarte de que estás accediendo a la instancia sin filtros.

La respuesta incluye el texto generado y las estadísticas de uso de tokens. Puedes analizar esto directamente en la lógica de tu aplicación.

Copycurl https://api.nsfwlocalllm.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Send me the server uptime stats"}]
  }'

Verifica códigos de estado HTTP estándar para manejar casos de éxito o fallo.

Activa la transmisión para salida en tiempo real

Transmite respuestas para reducir la latencia percibida para tus usuarios. Habilita el flujo estableciendo stream: true en tu cuerpo de solicitud. La API devuelve una serie de Eventos Enviados por Servidor (SSE) que contienen tokens parciales.

Agrégue estos tokens en el lado del cliente para reconstruir el mensaje completo. Este enfoque es ideal para interfaces de chat donde importa la retroalimentación inmediata. El último evento SSE contiene el uso total de tokens para la solicitud.

Copyfrom openai import OpenAI

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

Gestiona los errores de conexión de forma adecuada para garantizar una experiencia de usuario fluida.

Usa el modo JSON para datos estructurados

Forza al modelo a generar JSON válido para su consumo programático. Establece response_format para {"type": "json_object"} en tu solicitud. Esto reduce los errores de análisis y asegura estructuras de datos consistentes.

Usa esto para generar prompts estructurados, extraer entidades o construir contenido dinámico. El modelo se adhiere a las restricciones de formato proporcionadas en tus instrucciones del sistema. Esto es crucial para una integración fiable con otros servicios.

Copyimport OpenAI from "openai";

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

Valida la salida JSON en tu extremo para detectar cualquier caso límite.

Implementa la llamada de funciones

Define herramientas para ampliar las capacidades del modelo. Pasa un tools array con definiciones de funciones a la solicitud. El modelo puede elegir llamar a estas funciones basándose en el contexto.

Esto habilita flujos de trabajo complejos donde el LLM decide cuándo obtener datos o realizar acciones. Recibes los argumentos de la función en la respuesta y los ejecutas en tu lado. Pasa los resultados de vuelta al modelo para un razonamiento adicional.

Establecer tool_choice para auto para la toma de decisiones flexible. Esta función admite escenarios avanzados de roleplay que requieren acceso a datos externos.

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)