API 文件 & 快速入門

基礎 URL 與驗證

使用我們的 Base URL 和單一 API 金鑰進行連接。該端點接受標準標頭。替換 YOUR_API_KEY 使用來自您儀表板的字符串。

• 基礎 URL： https://api.ollamaopenaicompatibleapi.com/v1
• 模型 ID： uncensored

驗證依賴於 bearer token。將其傳遞至 Authorization 標頭。這可確保與任何 OpenAI SDK 相容的客戶端相容。您可以透過 Google 或電子郵件立即生成新金鑰。無需提供手機號碼。

聊天完成端點

向以下網址發送 POST 請求 /v1/chat/completions. 包含您的 messages 陣列與模型名稱。API 根據您的提示回傳文字輸出。這適用於使用標準參數的任何供應商。

設定 temperature 以控制創意，或將其設低以獲得精確度。您也可以定義 stop sequences。伺服器處理請求並回傳完成內容。這是大多數整合的核心互動。

請記住，錯誤不會消耗您的預付信用額。僅對成功的完成進行計費。這在除錯階段保護了您的預算。

Copycurl https://api.ollamaopenaicompatibleapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top 10 Linux kernel security patches from 2023"}]
  }'

透過 SSE 的串流回應

在請求主體中將 stream: true.伺服器在產生時傳送區塊。這顯著降低了感知延遲。您會即時收到部分回應。

解析伺服器發送事件串流。最後一個區塊包含用量統計。這包括輸入和輸出的 Token 計數。您可以在生成過程中動態追蹤成本。

此方法非常適合聊天介面。使用者會看到文字逐字出現。這比等待完整回應感覺更具回應性。API 會自動處理連線穩定性。

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)

函式呼叫與 JSON 模式

在請求主體中定義工具。模型可輸出結構化資料。使用 response_format 與 {"type": "json_object"} 用於嚴格的 JSON。這能確保每次都能產生可解析的輸出。

工具定義包括名稱、描述和參數。模型決定呼叫哪個工具。你執行函式並將結果回傳。這使得複雜的代理工作流程成為可能。

JSON 模式會停用自由文本生成。它強制模型遵循您的 schema。當與資料庫或 API 整合時請使用此功能。它會減少結構化欄位的幻覺現象。

Copyfrom openai import OpenAI

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

速率限制與請求主體

您每個金鑰每分鐘可獲得 300 次請求。併發限制為 8 個同時請求。最大請求主體大小為 8 MB。這適合大多數文字密集型應用程式。

上下文視窗總計允許 100,000 個 token。這包括提示和補全。每次請求的最大輸出為 16,000 個 token。如果你省略 max_tokens預設為 2,048。

優雅地處理 HTTP 429 錯誤。它們表示您達到了速率限制。在您的客戶端程式碼中實施指數退避。這可以防止在流量尖峰期間壓垮伺服器。

Copyimport OpenAI from "openai";

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

驗證錯誤與限制

401 狀態表示您的金鑰無效。請檢查是否有拼寫錯誤或工作階段已過期。402 狀態表示額度不足。請透過加密貨幣充值以恢復服務。

429 狀態表示已觸發速率限制。您已超過每分鐘 300 次請求。請降低吞吐量或升級您的金鑰。API 會回傳清晰的錯誤訊息。

信用永不過期。你可以隨時充值。最低充值金額為 $20。大額充值適用額外信用額度。這能確保你的專案順利運行。