Kimicode api 文件

基礎 URL 與驗證

使用提供的基礎 URL 和預付令牌金鑰連接 API。透過在請求標頭中傳遞您的 API 金鑰進行身份驗證，確保僅您的帳戶能存取您的額度。透過 Google 或電子郵件註冊，即可立即獲得金鑰，無需電話驗證。

Copycurl https://api.kimicodeapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "What is the current rate limit for free tier users?"}]
  }'

您的請求目標為標準的 OpenAI 相容端點。此設計允許您在更新基礎 URL 和憑證的情況下，無需重寫現有客戶端程式碼即可替換為我們的服務。

聊天完成端點

使用 POST /v1/chat/completions 端點。您必須指定模型 ID 為 uncensored 存取運行在我們伺服器上的優化大型語言模型。系統接受 user 或 assistant 等標準訊息角色，用於多輪對話。

Copyfrom openai import OpenAI

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

此端點處理文字輸入並返回生成的文字。它不支援嵌入、影像或音訊。專注於您的提示詞結構，以從無審查模型中獲得最佳結果。

串流回應 (SSE)

在請求中將 stream 參數設為 true，即可啟用即時令牌交付。API 會回傳伺服器發送事件（SSE）區塊，讓您的應用程式能夠在生成文字時即時顯示。最後一個區塊包含完整的令牌用量統計數據，用於帳單目的。

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)

串流降低了最終使用者的感知延遲。您可以處理每個到達的 token，這非常適合聊天介面。請記住，串流不會改變底層模型行為或 token 計費。

函式呼叫與工具

在請求中定義工具以讓模型輸出結構化函式呼叫。API 支援 tool_choice 參數，允許您強制模型使用特定工具或讓其自主決定。此功能與標準 OpenAI 工具格式相容，使整合變得簡單。

Copyimport OpenAI from "openai";

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

使用函式呼叫提取資料或觸發應用程式中的操作。模型解釋工具定義並返回包含必要參數的 JSON 物件。此功能將 API 擴展到簡單的文字生成之外。

JSON 模式與參數

透過設定強制執行嚴格的 JSON 輸出 response_format 以 {"type": "json_object"}. 這可確保模型返回 JSON，這對於程式化解析至關重要。您也可以調整 temperature、top_p 和 stop sequences 等參數，以控制創造力和輸出長度。

該模型支援 100,000 token 的上下文視窗。這允許您在單一請求中傳遞大量的上下文。每次請求的最大輸出為 16,000 個 token，若未指定 max_tokens 則為 2,048。

限制、錯誤與上下文

監控您的請求限制以避免服務中斷。API 每個金鑰每分鐘允許 300 次請求，最多 8 個並行請求。您的請求主體必須保持在 8 MB 以下。如果您超過這些限制，將收到 429 速率限制錯誤。

驗證失敗會返回 401 錯誤，如果金鑰無效。402 錯誤表示預付信用額度不足。生成過程中的錯誤不會消耗您的 token。上下文窗口包括提示和補全 token。未使用的信用額度永不過期，確保您的預付餘額可用於未來的專案。