跳到主要內容
指南
指南

快速入門

透過支援的同步或串流協定呼叫 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 用量,並在應用程式日誌中保留請求識別碼以供支援使用。