快速入門：整合 AI 女友 API

基礎 URL 與驗證

我們的 API 遵循 OpenAI chat-completions 標準，讓現有客戶的整合變得簡單。你必須在每個請求的 Authorization 標頭中包含你的 API 金鑰。所有端點的基礎 URL 為 https://api.roleplayapi.com/v1。使用官方 SDK 時，請將 base_url 設定指向此地址，並將你的金鑰作為 api_key 提供。此設定可確保你的請求無修改地到達我們專用的無審查端點。

發送補全請求

透過向 /v1/chat/completions 發送 POST 請求來啟動對話。模型識別碼為 uncensored。你可以在 messages 陣列中傳遞任意數量的訊息以建立上下文或開始全新對話。回應包含模型的文字輸出，你可以將其串流輸出或解析為 JSON 物件。此端點處理角色驅動應用程式所需的文字輸入、文字輸出核心互動。

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

Python SDK 整合

使用官方的 openai Python 函式庫，以最小的樣板程式碼與 API 互動。使用我們的基礎 URL 和 API 金鑰設定用戶端。然後，呼叫 chat.completions.create 並指定 uncensored 模型 ID。此方法利用現有的型別提示和錯誤處理機制，讓你能專注於應用程式邏輯，而非 HTTP 解析。回應物件可直接提供生成的內容。

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)

Node SDK 整合

對於 JavaScript 和 TypeScript 專案，OpenAI Node SDK 提供了清晰的 API 呼叫介面。使用自訂基礎 URL 和你的金鑰初始化用戶端。使用 uncensored 模型呼叫聊天補全端點。此方法非常適合需要高效管理非同步請求的網頁伺服器或邊緣函式。SDK 會自動處理 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);

啟用串流輸出

透過啟用伺服器推送事件 (SSE) 來降低感知延遲。在請求中將 stream 參數設為 true。API 將返回串流區塊，而非單一的完整回應。這對於期望即時字元回應的聊天介面特別有用。你可以隨著每個區塊到達進行處理，逐步更新 UI。當模型完成 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)

限制、錯誤與上下文

你的請求受速率限制約束，每分鐘每金鑰限 300 次請求。若超過此限制，API 將返回 429 狀態碼。驗證失敗會導致 401 錯誤，而預付額度不足則觸發 402 錯誤。上下文視窗支援最多 100,000 個 token（包含提示詞與補全）。如需檢查可用模型，請發送 GET 請求至 /v1/models。確保請求主體不超過 8 MB。