Szybki start: Integracja API AI Girlfriend

Bazowy URL i uwierzytelnianie

Nasze API jest zgodne ze standardem OpenAI chat-completions, co ułatwia integrację istniejącym klientom. Musisz dołączyć swój klucz API w nagłówku Authorization każdego zapytania. Podstawowy URL dla wszystkich endpointów to https://api.roleplayapi.com/v1. Przy korzystaniu z oficjalnych SDK zaktualizuj konfigurację base_url, aby wskazywała ten adres, i podaj swój klucz jako api_key. Ta konfiguracja zapewnia, że Twoje zapytania trafią do naszego dedykowanego endpointu bez cenzury bez modyfikacji Twojej standardowej logiki.

Wysłanie uzupełnienia

Zainicjuj rozmowę, wysyłając żądanie POST do /v1/chat/completions. Identyfikator modelu to uncensored. Możesz przekazać dowolną liczbę wiadomości w tablicy messages, aby ustalić kontekst lub rozpocząć świeżą dialog. Odpowiedź zawiera tekstowy output modelu, który możesz strumieniować lub zinterpretować jako obiekt JSON. Ten endpoint obsługuje podstawową interakcję tekst-w-wejście, tekst-wyjście wymaganą dla aplikacji opartych na postaciach.

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

Integracja z Python SDK

Użyj oficjalnej biblioteki Python openai do interakcji z API przy minimalnym nakładzie kodu. Skonfiguruj klienta z naszym bazowym URL i kluczem API. Następnie wywołaj chat.completions.create z ID modelu uncensored. To podejście wykorzystuje istniejące typy hintów i mechanizmy obsługi błędów, pozwalając Ci skupić się na logice aplikacji, a nie na parsowaniu HTTP. Obiekt odpowiedzi zapewnia bezpośredni dostęp do wygenerowanej treści.

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)

Integracja z Node SDK

Dla projektów JavaScript i TypeScript, Node SDK OpenAI zapewnia czysty interfejs dla wywołań API. Zainicjuj klienta z niestandardowym bazowym URL i swoim kluczem tajnym. Wywołaj endpoint uzupełnień czatu, używając modelu uncensored. Ta metoda jest idealna dla serwerów webowych lub funkcji brzegowych, gdzie musisz efektywnie zarządzać żądaniami asynchronicznymi. SDK automatycznie obsługuje serializację i deserializację ładunku 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);

Włączenie strumieniowania

Zmniejsz postrzeganą latencję, włączając zdarzenia wysyłane przez serwer (SSE). Ustaw parametr stream na true w swoim żądaniu. API zwróci strumień fragmentów zamiast jednej kompletnej odpowiedzi. Jest to szczególnie przydatne w interfejsach czatu, gdzie użytkownicy oczekują natychmiastowych odpowiedzi postaci. Możesz przetwarzać każdy fragment po jego przybyciu, aktualizując UI inkrementalnie. Strumień kończy się, gdy model zakończy generowanie sekwencji tokenów.

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)

Limity, błędy i kontekst

Twoje zapytania podlegają limitowi zapytań wynoszącemu 300 zapytań na minutę na klucz. Jeśli go przekroczysz, API zwróci kod statusu 429. Niepowodzenia uwierzytelnienia skutkują błędem 401, natomiast niewystarczający przedpłacony kredyt wywoła błąd 402. Okno kontekstu obsługuje do 100 000 tokenów dla połączonego promptu i uzupełnienia. Jeśli chcesz sprawdzić dostępne modele, wyślij żądanie GET do /v1/models. Upewnij się, że ciało Twojego żądania nie przekracza 8 MB.