規格摘要
如果你已有與 OpenAI 溝通的程式碼,OpenAI 相容 API 規格的簡短版本如下:變更 Base URL、變更金鑰,並將模型設為 uncensored。請求與回應主體遵循聊天補全格式,因此 SDK 無需修改即可解析。
| 項目 | 說明 |
|---|---|
| Base URL | https://api.unrestrictedaiapi.com/v1 |
| 驗證 | Authorization: Bearer YOUR_KEY |
| 端點 | POST /v1/chat/completions, GET /v1/models |
| 模型 ID | uncensored |
| 上下文視窗 | 100,000 token,含提示詞與補全 |
| 最大請求主體 | 8 MB |
| 輸出 | 僅文字 |
該模型是由獨立供應商運行的單一開放權重模型,針對合法成人用途進行微調,以無內容審查方式回答。它不是任何模型供應商的官方端點,也不在各供應商之間路由。這就是為什麼只有一個模型 ID 且模型列表很短的原因。
端點
GET /v1/models
回傳你的金鑰可用的模型。這是確認金鑰與 Base URL 正確的最便宜方式,許多 UI 客戶端會呼叫它來填充下拉選單。
curl https://api.unrestrictedaiapi.com/v1/models \
-H "Authorization: Bearer $KEY"
POST /v1/chat/completions
唯一的生成端點。你傳送包含 messages 物件陣列,每個物件帶有 role(system、user、assistant 或 tool)與 content,加上模型與任何採樣選項。最小呼叫範例:
curl https://api.unrestrictedaiapi.com/v1/chat/completions \
-H "Authorization: Bearer $KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [
{"role": "system", "content": "Answer in one sentence."},
{"role": "user", "content": "What is a base URL?"}
]
}'
回覆在 choices[0].message.content 包含生成的文字,並在 usage 包含 token 計數。這些計數是計費的依據。
不提供:舊版 completions 端點、嵌入、影像、音訊與影片端點、微調與檔案端點。呼叫這些端點的客戶端會收到錯誤,因此請在預設使用這些功能的工具中停用這些功能。
請求參數
接受並傳遞以下參數給模型:
temperature與top_p用於採樣。stop用於一個或多個停止序列。seed用於在其他條件相同時進行可重複採樣。presence_penalty與frequency_penalty用於減少重複。max_tokens,為可選參數。若未指定,生成的回應可使用剩餘的 100,000 token 上下文視窗。stream用於伺服器發送事件。tools與tool_choice用於函式呼叫。response_format搭配{"type":"json_object"}用於 JSON 模式。
兩個實用注意事項。第一,上下文視窗計算提示詞與補全合計,因此 90,000-token 的提示詞僅剩約 10,000 個 token 供回答使用。第二,主體限制為 8 MB,遠超過 100,000 個 token 文字的需求,因此只有在訊息中嵌入大型編碼負載時才會達到限制。
串流輸出
設定 stream: true,回應將以伺服器發送事件形式到達。每個事件為包含 delta 的 JSON 區塊,持有下一段文字,用量資訊會在串流結束時報告。SDK 隱藏了封裝細節;使用原始協定時,你需讀取以 data: 開頭的行,直到串流關閉。
from openai import OpenAI
client = OpenAI(base_url="https://api.unrestrictedaiapi.com/v1", api_key="YOUR_KEY")
with client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "List five HTTP status codes."}],
stream=True,
) as stream:
for chunk in stream:
if chunk.choices and chunk.choices[0].delta.content:
print(chunk.choices[0].delta.content, end="")
一條規則影響容量規劃:串流請求會佔用並行槽位直到串流結束,而非第一個 token 產生後。若客戶端在讀取時停滯,會持續佔用槽位。請務必關閉或完成串流,並設定客戶端逾時。
工具呼叫與 JSON 模式
函式呼叫
傳遞 tools 作為帶有 JSON Schema 參數的函式定義列表。若模型決定呼叫某個函式,訊息將包含 tool_calls,當 stream 開啟時也會串流輸出。你執行該函式,並以 role: "tool" 與對應的 tool_call_id 回傳結果作為訊息。使用 tool_choice 強制指定特定函式或讓模型自行決定。
{
"model": "uncensored",
"messages": [{"role": "user", "content": "Weather in Oslo?"}],
"tools": [{
"type": "function",
"function": {
"name": "get_weather",
"description": "Current weather for a city",
"parameters": {
"type": "object",
"properties": {"city": {"type": "string"}},
"required": ["city"]
}
}
}]
}
模型提出引數;它不會執行任何動作。如同處理任何使用者輸入,請在採取行動前驗證這些引數。
JSON 模式
新增 "response_format": {"type": "json_object"} 以要求單一有效的 JSON 物件。與其他 OpenAI 風格實作一樣,也請在提示詞中告知模型你需要的鍵,例如「回傳包含 title 與 tags 鍵的物件」。無論如何請在 try 區塊中解析結果,並保持 max_tokens 寬鬆,以免長物件被截斷。
限制、標頭與錯誤
| 金鑰類型 | 並行請求 | 每分鐘請求數 |
|---|---|---|
| 完整金鑰 | 8 | 300 |
| 試用金鑰 | 2 | 60 |
每個回應包含 X-Request-Id(聯繫 support 時請引用)、X-Balance-USD(剩餘額度)、X-RateLimit-Limit-Requests 與 X-RateLimit-Limit-Concurrency。
當超過限制時,API 回傳 HTTP 429。錯誤代碼區分以下情況:
rate_limited:一分鐘內請求過多。放慢速度或分散負載。concurrency:同時進行中的請求過多。請在您的端點進行排隊。- 帶有
Retry-After: 5標頭的 429:暫時過載。等待五秒後重試。
import time
import httpx
def post_with_retry(payload, key, tries=4):
# payload example: {"model": "uncensored", "messages": [...]}
for attempt in range(tries):
r = httpx.post(
"https://api.unrestrictedaiapi.com/v1/chat/completions",
headers={"Authorization": "Bearer " + key},
json=payload,
timeout=120,
)
if r.status_code == 429:
wait = int(r.headers.get("Retry-After", 2 ** attempt))
time.sleep(wait)
continue
return r
return r
失敗或被拒絕的請求不會計費。
角色、歷史紀錄與回應物件
API 為無狀態。它不記住先前的請求,因此對話僅存在於你每次傳送的 messages 陣列中。典型的歷史紀錄以一個設定行為的 system 訊息開始,隨後是交替的 user 與 assistant 訊息。當啟用函式呼叫時,tool 訊息會出現在它們之間,每個訊息透過 tool_call_id 連結至其回答的呼叫。
這有兩個後果。第一是成本:每個回合都需為整個歷史紀錄作為輸入付費,因此長對話即使每個問題很短,每則訊息的成本也會更高。第二是控制權:你可以隨時編輯、修剪或重寫歷史紀錄。刪除最舊的回合、以摘要取代或注入修正後的助手訊息都是普通操作,模型會將你傳送的內容視為事實。
回傳時,請讀取三項內容。choices[0].message 包含文字或工具呼叫。choices[0].finish_reason 說明生成停止的原因:自然結束、token 限制或工具呼叫。usage 包含提示詞、補全與總 token 計數。若完成原因指出達到 token 限制,文字將被截斷,你應提高限制或在後續回合要求模型繼續。
相容性檢查清單
在針對此端點發布客戶端之前,請執行這些檢查。它們能在幾分鐘內捕捉大多數整合問題。
- 使用你的金鑰呼叫
GET /v1/models,並確認回傳的列表包含uncensored。 - 傳送不含選項的純聊天請求,並確認收到帶有
usage區塊的正常回覆。 - 使用
stream: true重複測試,並確認客戶端能處理串流結束與最終用量資料。 - 若使用工具,請執行一次完整的工具呼叫往返,包括帶有
tool訊息的後續請求。 - 在試用金鑰上同時發送 10 個請求,並確認您的程式碼能處理第二個並行請求後出現的 429 錯誤。
- 為每次呼叫記錄
X-Request-Id,以便日後追蹤任何異常結果。
通過所有六項檢查表示你的客戶端已準備好處理真實流量。
與完整 OpenAI 平台的差異
相容性指的是聊天協定,而非整個平台。文字聊天以外的功能皆不存在,部分行為來自模型而非協定。模型名稱固定,回答風格可能與你之前使用的任何模型不同,且在使用相同的 seed 時,僅在提示詞和參數保持不變的情況下才可重複產生結果。
唯一無法變更的內容規則為:涉及未成年人的性內容會被封鎖。除此之外,該模型針對合法成人用途調整為避免拒絕回應,且提示詞不會用於訓練。
如需五種語言的程式碼範例,請參見 快速入門;若要了解提示詞技巧,請閱讀 提示無審查模型;帳戶相關資訊請見 定價,費率為每 100 萬個輸入 token $0.15,每 100 萬個輸出 token $0.50,且額度永不過期。文件以簡短形式提供相同的規格說明。
