跳到主要内容
Sursa Developers

API 参考

Sursa 公共 API:222 个接口,分为 35 个分组。版本 1.62.0。

面向使用 API 密钥进行身份验证的集成的 Sursa 公开 API。/v1 内的变更都是仅新增的变更:可能新增操作、可选参数、响应字段和响应中的枚举值,现有客户端可继续正常工作。响应中出现未知的枚举值时,应将其视为有效值。

基础 URL
https://api.sursa.com
身份验证
在 Authorization 请求头中传入 API 密钥:Authorization: Bearer <密钥>。

分组

health1 个接口

服务状态和版本

auth1 个接口

登录、会话、“View as”模式、修改和重置密码、接受邀请

users5 个接口

组织的用户账户

api-keys9 个接口

组织的 API 密钥

apps8 个接口

组织的 OAuth 应用和员工授权

oauth3 个接口

OAuth 2.0 协议:授权同意页面、令牌的签发与撤销、授权服务器元数据

audit4 个接口

组织的审计日志

org1 个接口

组织、组织徽标和数据导出

categories4 个接口

文档分类

collections6 个接口

知识合集

cards26 个接口

知识卡片:上传、内容、表格、版本、核实、评论

jobs5 个接口

索引队列:作业、解析预览、变更流(SSE)

conversations2 个接口

与助手的对话

answers3 个接口

搜索和助手的回答,包括 SSE 流

access-requests4 个接口

对被隐藏的回答所引用来源的访问申请

questions10 个接口

问题日志、建议、回答导出、实时回答

files8 个接口

导出文件

insights1 个接口

知识洞察:摘要、重复内容、知识缺口和知识健康度

tasks1 个接口

用户和团队的任务

sources19 个接口

数据源,例如 Google Drive 和 Confluence

permissions17 个接口

权限体系:权限注册表,以及组织、合集、卡片和数据源上直接授予和继承的权限

roles4 个接口

角色:权限的命名集合,包括内置角色和自定义角色

groups7 个接口

用户组:普通用户组、“All members”(全体成员)、角色组和个人组

folders7 个接口

合集的文件夹:最多三层的树形结构、相对同级项排序、一张卡片可放入多个文件夹、继承的权限

catalog6 个接口

外部服务(SaaS 和供应商)目录,包括名称、网站、分类、图标和描述,以及组织内使用的名称与目录条目之间的关联

drafts6 个接口

草稿和发布审批

verification9 个接口

核实:状态、截止日期、核实人、历史记录、“Verify first”队列、可信度评分(Trust Score)和离职交接

announcements5 个接口

必读公告:接收范围、已读确认、报告、提醒、导出

comments4 个接口

卡片的评论串(带锚点和状态)以及表情回应

webhooks17 个接口

组织的 Webhook:Webhook 的登记、事件订阅、签名、投递和重试

public-api1 个接口

面向集成的公开 API:本 API 的机器可读规范

uploads5 个接口

大文件的分段上传:上传会话、分段、带检查的完成上传,以及供卡片、压缩包或导入使用

analytics4 个接口

产品分析:使用事件、按对象统计的计数器、知识健康度、使用情况和贡献仪表板、续约报告和导出

quality3 个接口

回答质量:没有得到良好回答的问题,以及已着手处理的知识缺口

finance6 个接口

财务文档:汇率和往来单位名录

对象