API 文件
使用我們的 OpenAI 相容 API 開始生成無審查文本。向我們的基礎 URL 發送單一 POST 請求,即可從我們的專用模型獲取回應。
身份驗證與基礎 URL
使用您的 API 金鑰對每項請求進行身份驗證。基礎 URL 為 https://api.nsfwroleplayapi.com/v1. 設定 Authorization 標頭以 Bearer YOUR_API_KEY. 您的金鑰授予對 chat-completions 端點的存取權。
聊天完成端點
將您的提示詞發送至 POST /v1/chat/completions. 指定模型 "uncensored" 請求主體中。API 根據您的輸入返回生成的文字。
context_window 總計允許 100,000 個 token。這包含提示與補全內容。您可以設定 max_tokens 以限制輸出。
curl https://api.nsfwroleplayapi.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "Confirm monthly credit balance is active"}]
}'
串流與 token 使用量
在請求主體中將 stream: true. API 在生成 token 時會發送伺服器發送事件(SSE)。在您的應用程式中接收即時文字更新。這可改善長回應的使用者體驗。
最終的區塊包含總 token 使用量。請精確追蹤預付額度的消耗情況。錯誤不會消耗額度。
stream = 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)
參數:溫度、Top P 與 JSON 模式
使用 temperature 和 top_p. 調整這些參數以改變創造性或確定性。使用 response_format 與 {"type": "json_object"} 用於結構化資料。這能確保一致的輸出格式。
您也可以設定 seed 用於獲得可重現的結果。設定 stop 序列以提前停止生成。這些參數讓您可以進行精確控制。
from openai import OpenAI
client = OpenAI(base_url="https://api.nsfwroleplayapi.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)
速率限制與併發
每個 API 金鑰支援每分鐘 300 次請求。您可以同時進行 8 個請求。請求主體大小限制為 8 MB。超過這些限制將返回 429 錯誤。
您可以建立新金鑰以取代舊金鑰。每個帳戶僅允許一個活躍金鑰。管理您的金鑰以維持存取權。這確保了穩定的效能。
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.nsfwroleplayapi.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);
錯誤處理與拒絕
透過檢查 HTTP 狀態碼來處理錯誤。401 錯誤表示您的 API 金鑰無效。402 錯誤表示預付信用額度不足。請透過儀表板更新您的餘額。
429 錯誤表示已達到速率限制。請在重試前等待。模型會拒絕涉及未成年人的請求。允許所有其他合法的成人內容。請檢查回應主體以獲取詳細資訊。
常見問題
此 API 是否與 openai 相容?
是的,它遵循 OpenAI chat-completions 介面。您可以使用官方的 OpenAI SDK 或任何相容的客戶端。只需更新基礎網址和 API 金鑰即可。
上下文視窗的大小是多少?
上下文視窗為 100,000 個 token。此總和包含提示詞與補全內容。您可以設定每次請求的最大輸出長度。
錯誤會消耗我的預付信用額度嗎?
否,錯誤和拒絕回應免費。您只為成功回應中的 token 付費。這使我們的 API 在開發時具有成本效益。