全部產品
Search

搜尋本產品

    Qoder CN 系列：API 概覽

    文件中心

    Qoder CN 系列：API 概覽

    更新時間：Jul 03, 2026

    Qoder Cloud Agents API 提供完整的雲端 AI Agent 管理能力，涵蓋 Agent 建立、環境配置、會話管理、事件流處理等核心功能。所有介面遵循 RESTful 設計，使用 JSON 作為請求/響應格式。

    當前 API 處於 Beta 階段，部分功能可能在後續版本中調整。

    Gateway URL

    環境

    URL

    生產環境

    https://api.qoder.com.cn/api/v1/cloud

    版本

    API 當前為 v1 版本，所有端點通過 /v1/ 路徑首碼區分版本，無需傳遞額外的版本頭。

    可用 API 列表

    資源

    說明

    基礎路徑

    Agents

    Agent 執行個體的增刪改查與歸檔

    /agents

    Environments

    運行環境組態管理

    /environments

    Sessions

    Agent 會話的建立與生命週期管理

    /sessions

    Events

    會話事件流的讀取與推送

    /events

    Files

    檔案上傳與關聯管理

    /files

    Vaults

    敏感憑據的安全儲存

    /vaults

    Skills

    Agent 技能的註冊與管理

    /skills

    Memory Stores

    持久化記憶儲存

    /memory_stores

    Deployments

    定時部署自動化

    /deployments

    Forward Templates

    Forward Agent 模板定義、版本、歸檔與複製

    /api/v1/forward/templates

    Forward Identities

    Forward 身份建立、啟停、刪除與 Agent 查詢

    /api/v1/forward/identities

    Forward Identity Configs

    身份維度模板配置與生效配置查詢

    /api/v1/forward/identities/{identity_id}/templates

    Forward Channels

    Forward 渠道與二維碼會話管理

    /api/v1/forward/channels、/api/v1/forward/qr_sessions

    Forward Sessions

    Forward 會話生命週期、事件與 SSE 流

    /api/v1/forward/sessions

    Forward Resources

    Forward 外部資源註冊與列表

    /api/v1/forward/resources

    Forward Schedules

    Forward 定時任務與運行記錄管理

    /api/v1/forward/schedules、/api/v1/forward/schedule_runs

    請求大小限制

    • 單次請求 Body 最大：4 MB

    • 超過限制時服務端會截斷 Body，導致 JSON 解析失敗並返回 400 invalid_request_error（message: “Request body must be valid JSON.”）

    必需要求標頭

    每個 API 請求必須包含認證頭，建議同時攜帶 Content-Type：

    Authorization: Bearer $QODER_PAT
Content-Type: application/json  # 推薦但非強制，服務端可自動推斷

    Beta 狀態說明

    1. API 介面整體穩定，但簽名可能在未來版本迭代中微調

    2. 新增功能將以新的 beta 標識發布

    3. 建議在生產環境中做好版本鎖定與相容處理

    4. 當前所有功能均可直接使用，無需額外的 Beta 頭啟用

    快速驗證連通性

    # 列出當前賬戶下的 Agents（驗證認證與連通）
curl -s "https://api.qoder.com.cn/api/v1/cloud/agents?limit=1" \
  -H "Authorization: Bearer $QODER_PAT"

    成功響應樣本：

    {
  "data": [],
  "first_id": null,
  "last_id": null,
  "has_more": false
}

    限流說明

    當前 API 應用程式層暫無主動限流。網關層有全域突發流量抑制和 DDoS 防護，觸發時可能返回 429 或 503。建議用戶端對 5xx/429 實施指數退避重試（1s → 2s → 4s，最多 3 次）。

    下一步