跳转至

API 文档

您可以使用 OAuth2API 密钥 进行 API 认证。OAuth2 是一种标准授权框架,使应用程序能够安全地访问系统中的特定文档。另一方面,API 密钥提供了一种更简单的方法,从公共知识库中检索文档,而无需经历 OAuth2 认证过程。

API 概述

Rememberizer 提供了一整套用于处理文档、向量存储、备忘录等的 API。这些 API 被组织成以下类别:

认证 API

  • 注册,登录,电子邮件验证
  • 密码重置
  • OAuth 端点(谷歌,微软)
  • 令牌管理和注销

用户 API

  • 用户个人资料和账户信息
  • 用户入职

文档 API

  • 列出、创建和更新文档
  • 文档处理
  • 批量文档操作

搜索 API

  • 基本搜索
  • 主动搜索
  • 批量搜索操作

纪念品 API

  • 创建、列出、更新和删除纪念品
  • 管理纪念品文档

向量存储 API

  • 创建和列出向量存储
  • 上传文本和文件文档
  • 搜索向量存储
  • 批量上传和搜索

集成 API

  • 列出集成
  • OAuth 集成端点(Google Drive、Gmail、Slack、Dropbox)

应用程序 API

  • 列出和创建应用程序

常见知识 API

  • 列出和创建常见知识条目

团队 API

  • 团队管理
  • 团队成员
  • 基于角色的权限

有关企业集成模式、安全考虑和架构最佳实践,请参阅 企业集成模式 指南。

基础 URL

所有 API 端点相对于:

https://api.rememberizer.ai/api/v1/

认证

端点需要使用以下方式进行认证: - JWT 令牌(通过 Authorization 头或 cookies 传递) - API 密钥(通过 x-api-key 头传递)

有关特定端点的详细信息,请参考各个 API 文档页面。