Ollama API 文件說明:端點參考
本頁記錄了適用於無審查推理的 OpenAI-compatible API。透過變更 base URL 與 API key,即可與標準 SDK 搭配使用。
基礎 URL 與驗證
所有請求的基礎 URL 為 https://api.ollamaapidocumentation.com/v1. 通過 Authorization 標題。您的金鑰在儀表板上生成後即可立即使用。
- 使用官方 OpenAI SDK 或任何相容的客戶端。
- 將基礎 URL 設定為上述值。
- 將您的 API 金鑰包含在標頭中。
驗證很嚴格。如果金鑰遺失或無效,API 會返回 401 錯誤。這確保您的使用情況能被準確追蹤以進行計費。
聊天完成端點:POST /v1/chat/completions
透過 POST /v1/chat/completions. 端點接受包含 model field set to "uncensored" and a messages 陣列。
此端點處理文字生成。它不支援影像、音訊或影片。您可以串流傳輸回應或等待完整結果。
錯誤如 402 表示餘額不足。請求按實際 token 使用量收費。因餘額不足導致的拒絕免費。
模型列表:GET /v1/models
使用 GET /v1/models. 這返回一個模型物件列表。唯一的可用模型 ID 是 "uncensored"。
此端點有助於驗證連線。它確認基礎 URL 正確無誤。它也會顯示模型名稱和物件類型。
使用此方法在發送大量負載前除錯連線問題。
參數:溫度、Top P、Seed
使用 temperature, top_p,以及 seed. 該 seed parameter ensures deterministic outputs. Use it for debugging or consistent results.
設定 temperature 介於 0 和 2 之間。較低的值使回應更可預測。較高的值增加隨機性。 top_p 參數透過累積機率篩選 token。
這些參數的運作方式與 OpenAI API 完全相同。您可以將它們結合使用,以對風格進行精確控制。
串流回應與 Token 用量
在請求主體中將 stream: true. API 返回伺服器發送的事件 (SSE)。每個區塊包含部分文字。
最後一個區塊包含 token 使用統計數據。這讓您可以精確計算成本。您可以即時處理到達的 token。
串流可降低感知延遲。它非常適合聊天介面。伺服器會持續推送資料,直到回應完成為止。
限制、錯誤與上下文視窗
上下文視窗為 100,000 個 token。這包括輸入和輸出。您可以每次請求生成最多 16,000 個 token。預設最大輸出為 2,048 個 token。
每分鐘的速率限制為 300 次請求。您可以擁有 8 個並發請求。請求主體大小限制為 8 MB。
錯誤包含 401(無效金鑰)和 429(速率限制)。餘額不足錯誤會返回 402。這些錯誤清晰且具可操作性。
cURL
curl https://api.ollamaapidocumentation.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "list files in the current directory"}]
}'Python
from openai import OpenAI
client = OpenAI(base_url="https://api.ollamaapidocumentation.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)Node.js
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.ollamaapidocumentation.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);串流
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)常見問題
ollama API 文件的基礎 URL 為何?
基礎網址為 HTTPS://api.ollamaapidocumentation.com/v1。您必須在 SDK 設定中設定此項目,即可使用 uncensored LLM API。
如何處理 401 或 402 等錯誤?
401 錯誤表示您的 API 金鑰無效或缺失。402 錯誤表示您沒有預付信用額度。請使用加密貨幣充值以繼續使用。
上下文視窗的大小是多少?
上下文視窗為 100,000 個 token。此限制包含提示詞與補全內容。您可以將 max_tokens 設定為最高 16,000。
幾秒鐘內取得金鑰
註冊,取得金鑰,替換基礎 URL。完成。