Démarrage rapide : Intégration de l'API de petite amie IA

URL de base et authentification

Notre API suit le standard OpenAI chat-completions, rendant l'intégration simple pour les clients existants. Vous devez inclure votre clé API dans l'en-tête Authorization de chaque requête. L'URL de base pour tous les endpoints est https://api.roleplayapi.com/v1. Lors de l'utilisation des SDK officiels, mettez à jour la configuration base_url pour pointer vers cette adresse et fournissez votre clé en tant que api_key. Cette configuration garantit que vos requêtes atteignent notre endpoint sans censure dédié sans modifier votre logique standard.

Envoyer une complétion

Initiez une conversation en envoyant une requête POST vers /v1/chat/completions. L'identifiant du modèle est uncensored. Vous pouvez passer autant de messages que nécessaire dans le tableau messages pour établir le contexte ou commencer une nouvelle conversation. La réponse contient la sortie textuelle du modèle, que vous pouvez streamer ou analyser comme un objet JSON. Cet endpoint gère l'interaction principale texte en, texte out requise pour les applications basées sur des personnages.

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."}]
  }'

Intégration SDK Python

Utilisez la bibliothèque Python officielle openai pour interagir avec l'API avec un minimum de code boilerplate. Configurez le client avec notre URL de base et votre clé API. Ensuite, appelez chat.completions.create avec l'ID du modèle uncensored. Cette approche exploite les hints de type et les mécanismes de gestion d'erreurs existants, vous permettant de vous concentrer sur la logique de votre application plutôt que sur l'analyse HTTP. L'objet réponse fournit un accès direct au contenu généré.

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)

Intégration SDK Node.js

Pour les projets JavaScript et TypeScript, le SDK Node.js OpenAI fournit une interface propre pour les appels API. Initialisez le client avec l'URL de base personnalisée et votre clé secrète. Invoquez l'endpoint de complétions de chat en utilisant le modèle uncensored. Cette méthode est idéale pour les serveurs web ou les fonctions edge où vous devez gérer efficacement les requêtes asynchrones. Le SDK gère automatiquement la sérialisation et la désérialisation du payload 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);

Activer le streaming

Réduisez la latence perçue en activant les événements envoyés par le serveur (SSE). Définissez le paramètre stream sur true dans votre requête. L'API retournera un flux de chunks au lieu d'une réponse complète unique. Cela est particulièrement utile pour les interfaces de chat où les utilisateurs s'attendent à des réponses immédiates des personnages. Vous pouvez traiter chaque chunk à mesure qu'il arrive, en mettant à jour l'interface utilisateur de manière incrémentale. Le flux se termine lorsque le modèle termine la génération de la séquence 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)

Limites, erreurs et contexte

Vos requêtes sont soumises à une limite de débit de 300 requêtes par minute par clé. Si vous dépassez cette limite, l'API renvoie un code d'état 429. Les échecs d'authentification entraînent une erreur 401, tandis qu'un crédit prépayé insuffisant déclenche une erreur 402. La fenêtre de contexte prend en charge jusqu'à 100 000 tokens pour le prompt et la complétion combinés. Si vous devez vérifier les modèles disponibles, envoyez une requête GET vers /v1/models. Assurez-vous que le corps de votre requête ne dépasse pas 8 Mo.