跳到內容

開放平台 API 概覽

開放平台 API 讓腳本或第三方系統以你本人的身分管理 RouteAPI 帳戶:查詢餘額、建立和管理 API Key、檢視帳戶日誌(支援 CSV / JSONL 匯出)與用量統計。

Base URL: https://www.routeapi.ai/api/open/v1
認證方式: Authorization: Bearer rat_xxxx,建立與保存管理金鑰的方式見開放平台 API 認證。

Terminal window
curl https://www.routeapi.ai/api/open/v1/balance \
-H "Authorization: Bearer $ROUTEAPI_MANAGEMENT_KEY"

/api/open/v1 下的所有介面都使用同一個標頭。回應採用統一的 { success, message, data } 主體;格式、錯誤碼與頻率限制見錯誤與限制。

金額欄位均為站點顯示幣別下的金額,保留兩位小數(如 10.00),幣別由 查詢餘額 回傳。每個金額獨立四捨五入,因此彙總金額與逐行明細金額相加可能有 ±0.01 的差異。

列表類介面使用統一的頁碼分頁:

參數類型預設值說明
pinteger1頁碼,取值 1–1000000
page_sizeinteger10每頁筆數,取值 1–1000

顯式傳入的 p / page_size 必須落在上述範圍內,非整數、0、負數或超出範圍都回傳 400 invalid_request,不會自動取預設值或被截斷。回應中的 page / page_size 為實際生效的值。

日誌類介面的 total 最多統計到 10000,超過時 total 恆為 10000;需要完整資料請按時間範圍分段拉取。

query string 中不能出現未編碼的分號 ;,請編碼為 %3B,否則整個請求回傳 400 invalid_request。% 請編碼為 %25,空格請使用 + 或 %20。

以下路徑皆相對於 https://www.routeapi.ai/api/open/v1。

方法路徑說明
GET/balance查詢餘額
方法路徑說明
GET/keys列出 API Key
GET/keys/:id查詢單一 API Key
GET/keys/:id/key取得完整 API Key
POST/keys建立 API Key
PATCH/keys/:id修改 API Key
DELETE/keys/:id刪除 API Key
方法路徑說明
GET/logs查詢帳戶日誌
GET/logs/export匯出日誌
方法路徑說明
GET/usage查詢用量統計
GET/usage/models按模型統計用量
GET/usage/keys按 Key 統計用量