API 文件

基礎 URL 與驗證

API 位於 https://api.ollamaapidoc.com/v1. 使用 Authorization 標頭。在儀表板上透過 Google 或電子郵件立即產生您的金鑰。無需電話號碼。該金鑰可與標準 OpenAI SDK 配合使用，只需設定基礎 URL。

您的第一次請求

向以下網址發送 POST 請求 /v1/chat/completions 使用模型 ID uncensored. 此端點處理文字輸入與輸出。它支援串流傳輸、JSON 模式和函數調用。您可以先檢查 models 端點，在不消耗信用額度的情況下測試連線。

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

回應返回標準的 OpenAI 格式。錯誤會返回適當的 HTTP 代碼。請檢查主體中的 error 如果發生故障的詳情。串流回應使用伺服器發送事件 (SSE)。

Python SDK 集成

安裝官方 OpenAI 函式庫。使用您的基礎 URL 和 API 金鑰設定客戶端。呼叫 chat completions 端點。程式碼與標準 OpenAI 用法完全相同。這確保了現有專案的輕鬆遷移。您可以直接在呼叫中調整 temperature 和 top_p 等參數。

Copyfrom openai import OpenAI

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

處理速率限制或無效金鑰的例外情況。如果您將 stream 設為 true，該程式庫會串流式傳輸 token。這種方法能保持程式碼庫的整潔與相容性。

Node.js SDK 設置

使用 openai npm 套件。使用自訂 base URL 初始化客戶端。傳遞您的 API 金鑰。語法與 Python 範例相同。這種一致性可減少除錯時間。您可以在對話歷史陣列中傳送多則訊息。

Copyimport OpenAI from "openai";

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

仔細解析回應。API 返回結構化的 JSON。錯誤處理對於生產環境應用程式至關重要。分別捕獲網路錯誤和 API 特定錯誤。這確保您的應用程式在高流量期間保持響應。

串流與 JSON 模式

透過設定 stream 設為 true。API 透過 Server-Sent Events 傳送 token。您可以即時接收部分回應。這改善了長輸出的使用者體驗。您也可以使用 response_format. 這有助於結構化資料擷取。

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)

函式呼叫運作方式類似。在請求中定義工具。模型會回傳工具呼叫。在程式碼中解析這些呼叫。執行它們並將結果回傳給模型。這個循環使得複雜工作流程成為可能。

限制、錯誤與上下文

上下文視窗為 100,000 個 token。每次請求最大輸出為 16,000 個 token。錯誤包含 401（無效金鑰）與 402（信用額度不足）。速率限制上限為每分鐘 300 次請求。請在您的應用程式中優雅地處理這些情況。API 不會將您的提示詞用於訓練。隱私得到保障。信用額度不會過期。