简介

触发更新、嵌入 AI 助手等

Mintlify 的 REST API 使你能够以编程方式与文档交互、触发更新，并嵌入 AI 驱动的聊天体验。

​

端点

• 触发更新: 按需触发你的网站更新。
• 获取更新状态: 获取一次更新的状态以及你文档的其他详细信息。
• 创建代理任务: 创建代理任务以自动编辑你的文档。
• 获取代理任务: 获取特定代理任务的详细信息和状态。
• 获取所有代理任务: 获取某个 domain 的所有代理任务。
• 生成 AI 助手消息: 将基于你的文档训练的 AI 助手嵌入到任意应用中。
• 搜索文档: 在你的文档中进行搜索。

​

认证

你可以通过控制台生成 API key。API key 与整个组织关联，可在多个部署中使用。

​

管理员 API key

管理员 API key 用于 触发更新、获取更新状态 以及所有代理端点。

管理员 API key 以 mint_ 前缀开头。请妥善保管你的管理员 API key。

​

Assistant API key

assistant API key 用于 生成助手消息 和 搜索文档 端点。

assistant API key 以 mint_dsc_ 前缀开头。

assistant API 的 key 是应当保密的服务端令牌。

assistant API 的 token 是可在前端代码中引用的公共令牌。

使用 assistant API token 进行的调用可能会产生费用：可能会消耗你的 AI 助手额度，或产生超额费用。