跳转到主要内容

REST API 与 Webhook Team

套餐说明

REST API、Webhook 和 API 密钥适用于 Team 及 Enterprise。请参阅套餐与结算。

团队设置中的“开发者”标签页，包含 API 密钥和 Webhook 端点
设置 → 开发者 —— API 密钥、Webhook 端点及应用内 API 参考文档。

将您的会议数据打通至其他工作流。通过 REST API 拉取结构化笔记和转写文字，并在笔记生成完毕时接收 Webhook 通知——自动推送至 Slack、CRM 或数据仓库。

身份验证​

  1. 在网页端应用中，打开设置 → 开发者。
  2. 为团队创建 API 令牌。
  3. 在每次请求中将其作为 Bearer 令牌传入：
curl https://platform.scribx.app/api/v1/recordings \
  -H "Authorization: Bearer YOUR_API_TOKEN"

令牌的作用域限定在团队内，可随时撤销。

可拉取的内容​

  • 录制记录 —— 列出并获取包含元数据的会议
  • 转写文字 —— 标记发言人并带有时间戳的完整逐字稿
  • 摘要 —— 结构化会议总结及行动事项

如需浏览完整且始终保持最新的数据结构，请访问设置 → 开发者中的应用内 API 参考文档（Swagger UI）链接。

Webhook​

注册 Webhook URL 后，ScribX 会在发生关键事件时向其发送 POST 请求——最常用的是当会议笔记生成完毕时：

  1. 在设置 → 开发者中，添加 Webhook 端点。
  2. 选择要订阅的事件。
  3. 您的端点将接收到包含录制记录 ID 和事件类型的 JSON 有效载荷；随后可通过 API 获取详细信息。
{
  "event": "recording.note_ready",
  "recording_id": "rec_…",
  "team_id": "proj_…"
}
提示

验证有效载荷并迅速返回 2xx 响应，随后以异步方式处理耗时任务——若收到非 2xx 响应，ScribX 会自动重试。

后续步骤​