端点
- 触发更新: 按需触发你的网站更新。
- 获取更新状态: 获取一次更新的状态以及你文档的其他详细信息。
- 创建代理任务: 创建代理任务以自动编辑你的文档。
- 获取代理任务: 获取特定代理任务的详细信息和状态。
- 获取所有代理任务: 获取某个 domain 的所有代理任务。
- 生成 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。
认证
管理员 API key
mint_ 前缀开头。请妥善保管你的管理员 API key。
管理员 API key 是一个服务器端令牌。请务必保密。
Assistant API key
mint_dsc_ 前缀开头。
assistant API key 是一个公共令牌，你可以在前端代码中引用。
使用 assistant API token 进行的调用可能会产生费用：可能会消耗你的助手额度，或产生超额费用。