OpenAI-Compatible API 文件

快速入門：使用 OpenAI SDK 連接

首先使用您的金鑰進行身份驗證，並將客戶端指向我們的基礎 URL。此設置與 Python 和 Node.js 的官方 OpenAI SDK 配合使用，確保您可以使用相同的客戶端代碼對我們的服務進行調用。您需要儀表板上的有效 API 金鑰以及正確的端點配置。

Copycurl https://api.openaiapicompatible.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Return the current UTC timestamp in ISO 8601 format"}]
  }'

Copyfrom openai import OpenAI

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

Copyimport OpenAI from "openai";

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

聊天完成端點

將文字傳送至我們單一的聊天端點以獲取直接的文字輸出。我們使用 POST /v1/chat/completions 處理您的提示並返回生成的文字。這是大多數 LLM 應用的核心互動方式，無需複雜的路由或額外的服務呼叫。

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)

使用 SSE 串流

使用伺服器發送事件即時接收 token，以降低延遲。在請求中將串流參數設定為 true 以啟用串流。最後一個區塊包含 token 用量資料，讓您可以準確追蹤模型生成文字時的成本。此方法即使對於長輸出也能保持使用者介面的響應能力。

函式呼叫 & JSON 模式

整合工具並強制執行結構化輸出，以確保可靠的程式化互動。使用 tools 參數定義函式結構描述，並將 response_format 設為 json_object 以嚴格符合 JSON 規範。我們的無審查模型能處理複雜指令與邊緣案例，且不會拒絕有效的功能請求。

速率限制與參數

根據嚴格的金鑰限制來監控您的使用情況，以避免服務中斷。每個金鑰每分鐘允許 300 次請求和 8 個並行請求，主體大小限制為 8 MB。401（無效金鑰）、402（無信用額度）和 429（速率限制）等錯誤指示了特定的帳戶狀態。

上下文視窗 & 約束

透過 100,000 token 的視窗最大化上下文處理能力，以處理輸入與輸出的總和。設定 max_tokens 以控制生成長度，若未指定則預設為 2,048。我們的模型運行於自有伺服器上，而非作為其他供應商的代理，確保針對您特定使用情境的一致效能。