跳到內容

REST 端點

所有端點使用基本 URL https://api.hashee.ai。除標記為公開的端點外,驗證方式為 Authorization: Bearer {token}

驗證

方法路徑驗證說明
POST/auth/register公開註冊新帳號
POST/auth/login公開密碼登入
POST/auth/login-code公開驗證碼登入
POST/auth/send-code公開傳送驗證碼
POST/auth/refreshCookie重新整理 Access Token
POST/auth/logoutJWT登出當前工作階段
POST/auth/reset-password公開重設帳號密碼
POST/auth/change-passwordJWT更改帳號密碼
POST/auth/change-protection-passwordJWT更改保護密碼
GET/auth/meJWT取得當前使用者個人檔案
POST/auth/passkey/begin公開開始 Passkey 登入
POST/auth/passkey/complete公開完成 Passkey 登入
POST/auth/passkey/register/beginJWT開始 Passkey 註冊
POST/auth/passkey/register/completeJWT完成 Passkey 註冊
GET/auth/passkey/credentialsJWT列出 Passkey 憑證
PATCH/auth/passkey/credentials/:idJWT重新命名 Passkey
DELETE/auth/passkey/credentials/:idJWT刪除 Passkey

使用者

方法路徑驗證說明
GET/users/meJWT取得自己的個人檔案
PATCH/users/meJWT更新自己的個人檔案
GET/users/:idJWT依 ID 取得使用者
GET/users/searchJWT搜尋使用者
DELETE/users/meJWT停用並刪除帳號
PATCH/users/contacts/:idJWT設定聯絡人備註名稱

E2EE 金鑰

方法路徑驗證說明
POST/keys/backupJWT上傳加密金鑰備份
GET/keys/backupJWT下載金鑰備份
PUT/keys/backupJWT更新金鑰備份
GET/keys/users/:id/devicesJWT取得使用者裝置公鑰
GET/keys/agents/:idJWT取得 Agent 公鑰
GET/keys/groups/:idJWT取得群組加密金鑰
POST/keys/groups/:id/rotateJWT輪換群組金鑰
POST/keys/rotation/requestJWT請求 H2H 金鑰輪換
POST/keys/rotation/confirmJWT確認 H2H 金鑰輪換
POST/agents/:id/keys/registerAgent註冊 Agent 公鑰

對話

方法路徑驗證說明
GET/conversationsJWT列出對話
PATCH/conversations/:idJWT更新對話設定
DELETE/conversations/:idJWT隱藏對話
POST/conversations/:id/readJWT標記為已讀
GET/conversations/:id/messagesJWT取得訊息紀錄
GET/conversations/:id/mediaJWT取得對話中的媒體
PUT/conversations/:id/draftJWT儲存草稿
GET/conversations/:id/draftJWT取得草稿
DELETE/conversations/:id/draftJWT刪除草稿

訊息

方法路徑驗證說明
POST/conversations/:id/messagesJWT傳送訊息
POST/messages/:id/recallJWT收回訊息
POST/messages/:id/reactionsJWT新增/移除回應表情
GET/messages/:id/reactionsJWT取得回應表情列表
POST/messages/forwardJWT轉發訊息(最多 10 個目標)
PATCH/messages/:id/artifactAgent更新 Artifact

群組

方法路徑驗證說明
POST/groupsJWT建立群組
GET/groups/:idJWT取得群組詳情
PATCH/groups/:idJWT更新群組設定
DELETE/groups/:idJWT刪除群組
GET/groups/:id/membersJWT列出成員
POST/groups/:id/membersJWT新增成員
DELETE/groups/:gid/members/:midJWT移除成員
PATCH/groups/:gid/members/:midJWT更新成員角色
PATCH/groups/:gid/members/meJWT更新自己的群組個人檔案
POST/groups/:gid/leaveJWT離開群組
POST/groups/:id/transferJWT轉移擁有權
POST/groups/:gid/joinJWT透過分享碼加入群組
GET/groups/:gid/join-requestsJWT列出待處理的加入請求
POST/groups/:gid/join-requests/:uid/approveJWT批准加入請求
POST/groups/:gid/join-requests/:uid/rejectJWT拒絕加入請求
POST/groups/:id/pinned-messagesJWT釘選訊息
GET/groups/:id/pinned-messagesJWT列出釘選訊息
DELETE/groups/:gid/pinned-messages/:midJWT取消釘選訊息
POST/groups/:gid/members/:mid/muteJWT靜音成員
POST/groups/:id/agent-instancesJWT新增 Agent 到群組
DELETE/groups/:gid/agent-instances/:iidJWT從群組移除 Agent

Agent 管理(創作者)

方法路徑驗證說明
POST/agentsJWT建立 Agent
GET/agentsJWT列出自己的 Agent
GET/agents/:idJWT取得 Agent 詳情
PATCH/agents/:idJWT更新 Agent 個人檔案
DELETE/agents/:idJWT刪除 Agent
GET/agents/check-idJWT檢查自訂 ID 可用性
GET/agents/:id/tokenJWT取得 Agent Token
POST/agents/:id/token/regenerateJWT重新產生 Token
GET/agents/:id/commandsJWT取得斜線命令
POST/agents/:id/commandsJWT更新斜線命令
GET/agents/:id/invite-codesJWT列出邀請碼
POST/agents/:id/invite-codesJWT建立邀請碼
PATCH/invite-codes/:idJWT更新邀請碼
GET/agents/:id/requestsJWT列出使用者請求
POST/agents/:id/requests/:rid/approveJWT批准使用者請求
POST/agents/:id/users/:uid/suspendJWT暫停使用者
POST/agents/:id/users/:uid/restoreJWT恢復使用者
GET/agents/:id/governanceJWT取得治理狀態

Agent 端點(Agent Token 驗證)

方法路徑驗證說明
POST/agents/:id/conversations/:cid/messagesAgent傳送訊息
POST/agents/:id/typingAgent傳送輸入中指示器
GET/agents/:id/messages/pollAgent輪詢訊息
GET/agents/:id/conversationsAgent列出對話
GET/agents/:id/conversations/:cid/messagesAgent取得對話訊息
POST/agents/:id/filesAgent請求檔案上傳 URL
PUT/agents/:id/files/:uploadId/uploadAgent上傳檔案二進位檔

檔案

方法路徑驗證說明
POST/files/presignJWT請求預簽名上傳 URL
PUT/files/:upload_id/uploadJWT上傳檔案二進位檔
POST/files/confirmJWT以 SHA-256 確認上傳

其他

方法路徑驗證說明
GET/health公開健康檢查
GET/searchJWT搜尋參與者和 Artifact
POST/reportsJWT檢舉 Agent
POST/share/friendJWT建立好友分享連結
POST/share/agentJWT建立 Agent 分享連結
POST/share/groupJWT建立群組分享連結
GET/share/*公開解析分享連結

下一步