API 文件說明¶
您可以使用 OAuth2 或 API 金鑰 來驗證 API。OAuth2 是一個標準的授權框架,使應用程序能夠安全地訪問系統內的特定文檔。另一方面,API 金鑰提供了一種更簡單的方法來從公共知識庫中檢索文檔,而無需經過 OAuth2 驗證過程。
API 概述¶
Rememberizer 提供了一套全面的 API,用於處理文檔、向量存儲、備忘錄等。這些 API 被組織成以下幾個類別:
認證 API¶
- 註冊、登入、電子郵件驗證
- 密碼重設
- OAuth 端點(Google、Microsoft)
- 令牌管理和登出
使用者 API¶
- 使用者個人資料和帳戶資訊
- 使用者入門指南
文件 API¶
- 列出、創建和更新文件
- 文件處理
- 批量文件操作
搜尋 API¶
- 基本搜尋
- 主動搜尋
- 批次搜尋操作
Mementos APIs¶
- 創建、列出、更新和刪除 Mementos
- 管理 Memento 文件
向量儲存 API¶
- 創建和列出向量儲存
- 上傳文本和文件文檔
- 搜索向量儲存
- 批量上傳和搜索
整合 API¶
- 列出整合
- OAuth 整合端點(Google Drive、Gmail、Slack、Dropbox)
應用程式 API¶
- 列出和創建應用程式
常見知識 API¶
- 列出和創建常見知識項目
團隊 API¶
- 團隊管理
- 團隊成員
- 基於角色的權限
有關企業整合模式、安全考量和架構最佳實踐,請參閱 企業整合模式 指南。
基本 URL¶
所有 API 端點相對於:
認證¶
端點需要使用以下方式進行認證: - JWT 令牌(通過授權標頭或 cookies 傳遞) - API 金鑰(通過 x-api-key 標頭傳遞)
有關特定端點的詳細信息,請參閱各個 API 文檔頁面。