Ollama API 快速入門指南

基礎 URL 與驗證設定

設定您的客戶端指向我們的主機端點。設定 base_url 以 https://api.apiollama.com/v1 並提供金鑰至 Authorization 標頭。驗證使用標準 Bearer 機制。您可以在儀表板透過 Google 或電子郵件產生金鑰。系統為每個帳戶建立一個有效金鑰。

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

保持您的金鑰安全。如果您需要新的金鑰，請在儀表板上生成新金鑰，舊金鑰將立即變為非活動狀態。設定不需要電話號碼。此設定適用於任何 OpenAI-compatible 客戶端。

POST /v1/chat/completions：發送請求

使用標準端點傳送您的第一個聊天補全請求。將模型 ID 指定為 uncensored 請求主體中。API 接受包含系統、使用者和助手角色的標準訊息陣列。這適用於支援 OpenAI 格式的任何 SDK。請確保包含 model field in every request.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.apiollama.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 用於控制隨機性。系統返回一個包含生成內容的完整回應物件。

GET /v1/models：列出可用模型

查詢 models 端點以驗證可用選項。發送 GET 請求至 /v1/models 列出託管的模型。回應包含 id field set to uncensored. 此端點確認您的 API 金鑰具有有效權限。它返回關於模型配置的元數據。

Copyimport OpenAI from "openai";

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

使用此呼叫來偵錯連線問題。如果端點返回錯誤，請檢查您的認證標頭。端點提供可用模型清單。您可以在不發送完整聊天請求的情況下驗證服務狀態。

帶有伺服器發送事件 (SSE) 的串流回應

透過設定 stream 將參數設為 true。API 會為即時 token 交付回傳伺服器發送事件（SSE）。每個區塊包含部分內容更新。最後一個區塊包含完整的 token 使用統計資料。這可降低長回應的感知延遲。

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 串流。每個事件到達時處理它。最後一個事件包含 usage 包含輸入和輸出 token 數量的物件。串流傳輸支援所有支援的參數。它為互動式應用程式提供即時回饋。

設定參數：溫度、Top-p 等

使用標準參數調整生成行為。設定 temperature 用於隨機性，以及 top_p 用於核採樣。使用 stop 序列以提前停止生成。該 seed 參數可確保結果可重現。您也可以設定 presence_penalty 和 frequency_penalty 用於風格控制。

JSON 模式可透過 response_format. 設為 json_object 用於結構化輸出。模型會遵循指定的格式。這些參數適用於所有請求。使用它們來微調回應風格。

錯誤處理與 Token 使用報告

在您的應用程式中處理常見的 HTTP 錯誤。401 狀態碼表示 API 金鑰無效。402 狀態碼表示您的預付額度已耗盡。429 狀態碼表示您已超過速率限制。請檢查回應主體以獲取詳細的錯誤訊息。因內容政策而產生的拒絕是免費的。

上下文視窗支援 100,000 個 token 總量。每次請求的輸出限制為 16,000 個 token。若 max_tokens 未設定。Token 使用量在最後一個串流區塊中報告。錯誤不消耗信用額度。