接口參考
總覽
基礎地址、認證與全部接口。
下表中的路徑都帶版本前綴 /v1,完整地址為 https://agent.hkgai.net/open/api 加上路徑。所有接口都需要認證。錯誤回應的格式見錯誤,列表接口的分頁見分頁。
接口總表
| 方法 | 路徑 | 說明 |
|---|---|---|
| GET | /v1/models | 模型列表 |
| POST | /v1/sessions | 建立會話 |
| GET | /v1/sessions | 會話列表 |
| GET | /v1/sessions/{session_id} | 查詢會話 |
| PATCH | /v1/sessions/{session_id} | 更新會話 |
| DELETE | /v1/sessions/{session_id} | 刪除會話 |
| POST | /v1/sessions/{session_id}/messages | 發送訊息 |
| POST | /v1/sessions/{session_id}/cancel | 取消執行 |
| GET | /v1/sessions/{session_id}/events | 事件歷史 |
| GET | /v1/sessions/{session_id}/events/stream | 事件串流 |
| POST | /v1/files | 上載檔案 |
| GET | /v1/files | 檔案列表 |
| GET | /v1/files/{file_id} | 查詢檔案 |
| GET | /v1/files/{file_id}/content | 下載檔案 |
| DELETE | /v1/files/{file_id} | 刪除檔案 |
| POST | /v1/skills | 上載技能 |
| GET | /v1/skills | 技能列表 |
| GET | /v1/skills/{skill_id} | 查詢技能 |
| DELETE | /v1/skills/{skill_id} | 刪除技能 |
| POST | /v1/mcp-servers | 註冊 MCP 伺服器 |
| GET | /v1/mcp-servers | MCP 伺服器列表 |
| GET | /v1/mcp-servers/{mcp_server_id} | 查詢 MCP 伺服器 |
| PATCH | /v1/mcp-servers/{mcp_server_id} | 修改 MCP 伺服器 |
| POST | /v1/mcp-servers/{mcp_server_id}/probe | 重新探測 |
| DELETE | /v1/mcp-servers/{mcp_server_id} | 刪除 MCP 伺服器 |
範例的約定
每個接口的右欄給出 curl、Python 和 Node.js 三種請求範例,選擇一種後全站保持。
- curl 引用環境變數
AXON_API(API 地址)和AXON_KEY(API Key),與快速開始相同。 - Python 假定已經建好客戶端
client = httpx.Client(base_url=API, headers=HEADERS),API與HEADERS的定義見客戶端範例;路徑因此寫成相對路徑。 - Node.js 假定已定義
API與HEADERS(含Authorization與Content-Type: application/json);上載檔案時只傳Authorization,由fetch自己設定 multipart 的Content-Type。