端点
- 触发更新：在需要时触发您站点的更新。
- 获取更新状态：获取某次更新的状态以及与您的文档相关的其他详细信息。
- 创建代理任务：创建一个代理任务以自动编辑您的文档。
- 获取代理任务：获取特定代理任务的详细信息和状态。
- 获取所有代理任务：获取某个 domain 下的所有代理任务。
- 生成 AI 助手消息：将基于您的文档训练的 AI 助手嵌入到任意您选择的应用中。
- 搜索文档：搜索您的文档。
- 获取用户反馈：从您的文档中导出用户反馈。
- 获取 AI 助手会话：导出 AI 助手的会话历史。
常见用例
- 自动化部署：使用 Trigger update 和 Get update status，在设定的时间间隔或当特定事件发生时触发站点更新。
- CI/CD 集成：在代码变更时，将文档更新作为部署流水线的一部分来执行，使用 Trigger update。
- 自定义集成：使用 Generate assistant message 和 Search documentation，将 AI 助手嵌入到你的产品、支持门户或内部工具中。
- 自动化编辑：使用 agent 任务，以编程方式大规模更新文档，配合 Create agent job、Get agent job 和 Get all agent jobs。
- Analytics 导出：使用 Get user feedback 和 Get assistant conversations，导出反馈和 AI 助手会话以进行外部分析。
认证
管理员 API key
mint_ 前缀开头。
管理员 API key 是一个服务器端密钥。不要在客户端代码中暴露它。
Assistant API key
mint_dsc_ 前缀开头。
assistant API key 是一个公共令牌，你可以在前端代码中引用。
使用 assistant API token 进行的调用可能会产生费用：可能会消耗你的助手额度，或产生超额费用。