API 參考

上線前檢查

正式上線前請完成這份檢查清單,把金鑰安全、重試、非同步任務持久化、可觀測性和計費統一納入上線把關。

#正式環境檢查清單

安全

  • API 金鑰必須存放在可信的伺服器端,絕不能放入瀏覽器程式碼或行動裝置安裝包。
  • 每個專案使用獨立的受限金鑰,並設定模型、IP、RPM、RPD 和額度上限。
  • 無需修改模型接入程式碼即可輪換金鑰。

可靠性

  • 為每個請求設定連線和回應逾時。
  • 遵循 Retry-After,並使用帶抖動的指數退避。
  • 會計費的非同步提交必須使用 Idempotency-Key,並持久儲存 task_id。

可觀測性

  • 記錄請求 ID、模型、端點、延遲、HTTP 狀態和 task_id。
  • 除非明確開啟除錯,否則不要在日誌中記錄提示詞內容。
  • 把客戶看到的失敗關聯到對應的請求日誌記錄。

成本控制

  • 從即時模型後設資料讀取價格和支援選項。
  • 設定專案額度上限,並在錢包耗盡前告警。
  • 以請求日誌中保留六位小數的最終消費進行對帳。

#上線把關

  1. 1

    測試最小請求

    在工作台執行準確的模型和端點,然後複製產生的請求。

  2. 2

    測試失敗路徑

    驗證 401、402、429、逾時、無效媒體和任務失敗終態的處理。

  3. 3

    驗證計費

    將成功請求與對應的六位小數消費和請求 ID 核對。

  4. 4

    啟用監控

    針對錯誤率、延遲、卡住的任務、Webhook 失敗和低餘額設定告警。

#營運快捷入口

還是沒解決?

把請求 ID 或錯誤訊息傳給我們,我們來查。