Guida rapida: Integra l'API per fidanzata AI

URL di base e autenticazione

La nostra API segue lo standard OpenAI chat-completions, rendendo l'integrazione semplice per i clienti esistenti. Devi includere la tua chiave API nell'Authorization header di ogni richiesta. L'URL di base per tutti gli endpoint è https://api.roleplayapi.com/v1. Quando usi gli SDK ufficiali, aggiorna la configurazione di base_url per puntare a questo indirizzo e fornisci la tua chiave come api_key. Questa configurazione garantisce che le tue richieste raggiungano il nostro endpoint senza censura dedicato senza modificare la tua logica standard.

Invia una completazione

Inizia una conversazione inviando una richiesta POST a /v1/chat/completions. L'identificatore del modello è uncensored. Puoi passare qualsiasi numero di messaggi nell'array messages per stabilire il contesto o iniziare un dialogo fresco. La risposta contiene l'output testuale del modello, che puoi streammare o analizzare come oggetto JSON. Questo endpoint gestisce l'interazione core testo-in, testo-out richiesta per le app basate su personaggi.

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

Integrazione SDK Python

Utilizza la libreria Python ufficiale openai per interagire con l'API con il minimo boilerplate. Configura il client con il nostro URL di base e la tua chiave API. Quindi, chiama chat.completions.create con l'ID del modello uncensored. Questo approccio sfrutta i suggerimenti di tipo e i meccanismi di gestione degli errori esistenti, permettendoti di concentrarti sulla logica della tua applicazione piuttosto che sull'analisi HTTP. L'oggetto di risposta fornisce l'accesso diretto al contenuto generato.

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)

Integrazione SDK Node.js

Per i progetti JavaScript e TypeScript, l'SDK Node.js di OpenAI fornisce un'interfaccia pulita per le chiamate API. Inizializza il client con l'URL di base personalizzato e la tua chiave segreta. Invoca l'endpoint delle completazioni di chat utilizzando il modello uncensored. Questo metodo è ideale per server web o funzioni edge dove devi gestire le richieste asincrone in modo efficiente. L'SDK gestisce automaticamente la serializzazione e la deserializzazione del 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);

Abilita lo streaming

Riduci la latenza percepita abilitando gli eventi inviati dal server (SSE). Imposta il parametro stream su true nella tua richiesta. L'API restituirà uno stream di chunk invece di una singola risposta completa. Questo è particolarmente utile per le interfacce di chat dove gli utenti si aspettano risposte immediate dai personaggi. Puoi elaborare ogni chunk man mano che arriva, aggiornando l'UI in modo incrementale. Lo stream termina quando il modello termina di generare la sequenza di token.

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)

Limiti, errori e contesto

Le tue richieste sono soggette a un limite di richieste di 300 richieste al minuto per chiave. Se superi questo limite, l'API restituisce un codice di stato 429. I fallimenti di autenticazione risultano in un errore 401, mentre un credito prepagato insufficiente attiva un errore 402. La finestra di contesto supporta fino a 100.000 token per il prompt e la completazione combinati. Se devi verificare i modelli disponibili, invia una richiesta GET a /v1/models. Assicurati che il corpo della tua richiesta non superi gli 8 MB.