OpenAI 相容 API 文件

前置條件：SDK 與基礎 URL

開始安裝您偏好的程式庫並將其指向我們的端點。 base_url 是 https://api.apicompatible.com/v1. 此 OpenAI 相容 API 文件確認標準庫可以立即使用。您不需要路由器或複雜的閘道器設置。更改 URL 和金鑰，然後運行您的現有程式碼。

驗證：標頭與金鑰格式

將您的金鑰發送至 Authorization 標頭. 使用格式 Bearer your_api_key。我們的 API 採用標準的 OpenAI 相容 API 金鑰結構。金鑰可透過 Google 或電子郵件登入即時生成。請妥善保管您的金鑰，因為它代表對您預付餘額的存取權。

聊天完成端點

將請求發布到 /v1/chat/completions. 將模型指定為 uncensored. API 會直接回傳文字回應。您可以使用以下 curl 指令來驗證連線：

Copycurl https://api.apicompatible.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List available models"}]
  }'

此 OpenAI SDK 相容方法確保您獲得不受限制的文字生成。該模型可處理複雜提示，且不會對合法內容產生不必要的拒絕。

帶有 SSE 的串流回應

在請求主體中將 stream: true. 回應透過伺服器發送事件（SSE）到達。Token 使用詳情出現在最後一個區塊。此 OpenAI 相容的 API 文件支援標準串流協定。用於即時使用者體驗：

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.apicompatible.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)

串流可顯著降低感知延遲。它能與標準的客戶端程式庫無縫配合。

參數：Temperature、Top-P 與 Tools

使用標準參數控制生成。設定 temperature 用於隨機性或 top_p 用於核採樣。啟用 tools 用於函式呼叫。JSON 模式可透過 response_format. 該 uncensored model 有效遵守這些限制：

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.apicompatible.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);

這些參數允許對輸出風格進行微調控制。您可以為程式化用例強制執行嚴格的 JSON 結構。

限制：速率限制與主體大小

每個金鑰允許每分鐘 300 次請求。每個金鑰的併發請求限制為 8。最大請求主體大小為 8 MB。上下文視窗總計支援 100,000 tokens。處理 401 錯誤時請檢查您的金鑰。透過充值信用額度解決 402 錯誤。透過實作退避邏輯管理 429 錯誤。

串流

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)