Inicio rápido: Integra la API de Novia de IA

URL base y autenticación

Nuestra API sigue el estándar de chat-completions de OpenAI, lo que facilita la integración para clientes existentes. Debes incluir tu clave de API en el encabezado Authorization de cada petición. La URL base para todos los endpoints es https://api.roleplayapi.com/v1. Al usar SDK oficiales, actualiza la configuración de base_url para apuntar a esta dirección y proporciona tu clave como api_key. Esta configuración asegura que tus peticiones lleguen a nuestro endpoint sin censura dedicado sin modificar tu lógica estándar.

Enviar una finalización

Inicia una conversación enviando una petición POST a /v1/chat/completions. El identificador del modelo es uncensored. Puedes pasar cualquier número de mensajes en la matriz messages para establecer contexto o iniciar un diálogo nuevo. La respuesta contiene la salida de texto del modelo, que puedes transmitir o analizar como un objeto JSON. Este endpoint maneja la interacción principal de entrada y salida de texto necesaria para aplicaciones basadas en personajes.

Copycurl https://api.roleplayapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

Integración con SDK de Python

Usa la biblioteca oficial de Python openai para interactuar con la API con la menor cantidad de código posible. Configura el cliente con nuestra URL base y tu clave de API. Luego, llama a chat.completions.create con el ID del modelo uncensored. Este enfoque aprovecha las sugerencias de tipos y los mecanismos de manejo de errores existentes, permitiéndote centrarte en la lógica de tu aplicación en lugar del análisis de HTTP. El objeto de respuesta proporciona acceso directo al contenido generado.

Copyfrom openai import OpenAI

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

Integración con SDK de Node.js

Para proyectos de JavaScript y TypeScript, el SDK de Node.js de OpenAI proporciona una interfaz limpia para las llamadas a la API. Inicializa el cliente con la URL base personalizada y tu clave secreta. Invoca el endpoint de finalizaciones de chat usando el modelo uncensored. Este método es ideal para servidores web o funciones de borde donde necesitas gestionar peticiones asíncronas de manera eficiente. El SDK maneja automáticamente la serialización y deserialización de la carga útil JSON.

Copyimport OpenAI from "openai";

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

Habilitar streaming

Reduce la latencia percibida habilitando eventos enviados por el servidor (SSE). Establece el parámetro stream en true en tu petición. La API devolverá un flujo de fragmentos en lugar de una respuesta completa única. Esto es especialmente útil para interfaces de chat donde los usuarios esperan respuestas inmediatas de los personajes. Puedes procesar cada fragmento a medida que llega, actualizando la interfaz de usuario de forma incremental. El flujo termina cuando el modelo termina de generar la secuencia de tokens.

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)

Límites, errores y contexto

Tus peticiones están sujetas a un límite de peticiones de 300 peticiones por minuto por clave. Si excedes este límite, la API devuelve un código de estado 429. Los fallos de autenticación resultan en un error 401, mientras que el crédito prepago insuficiente activa un error 402. La ventana de contexto admite hasta 100.000 tokens para el prompt y la finalización combinados. Si necesitas verificar los modelos disponibles, envía una petición GET a /v1/models. Asegúrate de que el cuerpo de tu petición no supere los 8 MB.