指南
快速入門
透過支援的同步或串流協議調用 RunAPI 語言模型。
RunAPI 透過熟悉的公共協議形式公開語言模型。將現有相容客戶端指向 https://runapi.ai,使用 RunAPI 模型識別符,並以標準 API 金鑰進行身份驗證。
選擇協議
- 兼容 OpenAI 的 Chat Completions 使用
POST /v1/chat/completions。 - 兼容 OpenAI 的 Responses 使用
POST /v1/responses。 - 兼容 Anthropic 的 Messages 使用
POST /v1/messages。 - 兼容 Gemini 的內容生成使用
/v1beta/models/{model}:generateContent或:streamGenerateContent。
選擇最符合您現有客戶端及應用程式流程的協議。模型目錄標識每個模型支援的公共協議。
傳送請求
此 Chat Completions 請求返回一個同步回應:
SHELL
curl "https://runapi.ai/v1/chat/completions" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"model": "gpt-5.4",
"messages": [{"role": "user", "content": "Summarize why idempotency matters."}]
}'
保持請求及回應符合所選協議格式。使用操作的 API 參考獲取確切欄位、工具呼叫、結構化輸出及特定模型的限制。
串流輸出
設定協議的串流選項,並逐步消費返回的伺服器推送事件。對於 Chat Completions,請新增 "stream": true;對於 Gemini 相容呼叫,請使用 :streamGenerateContent 操作。當客戶端收到協議的終止事件時,關閉串流。
檢查交付保真度
每個已接受的 LLM 回應均包含 X-RunAPI-Fidelity。值為
full 表示請求已完整交付,沒有任何遺漏。值為
lossy 表示 RunAPI 省略了部分可選控制以完成請求;
X-RunAPI-Omitted-Fields 包含以逗號分隔的欄位名稱。
無法保留所需生命週期、延續、工具或類型化項目語義的請求將在建立 Task 之前被拒絕。
兩個標頭均透過 CORS 公開,因此瀏覽器客戶端可以檢查 它們。當應用程式需要精確的傳送行為時,請將它們與請求識別碼一併記錄。
處理錯誤及用量
將 401 視為身份驗證失敗,將 4xx 回應視為請求或政策問題,並僅對暫時性的伺服器或網絡故障進行重試。從所選協議格式的最終回應或終止串流事件中讀取 token 用量,並在應用程式日誌中保留請求識別符以供支援使用。