简介

触发更新、嵌入 AI 助手等

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

​

端点

• 触发更新: 按需触发站点更新。
• 获取更新状态: 获取更新状态及文档的其他详细信息。
• 生成文档助手消息: 将基于文档训练的文档助手嵌入到任意应用中。
• 搜索文档: 搜索你的文档。

​

认证

你可以在控制台生成 API 密钥。API 密钥与整个组织绑定，可用于多个部署环境。

​

管理员 API 密钥

管理员 API 密钥用于 Trigger update 和 Get update status 端点。

管理员 API 密钥以 mint_ 为前缀。请妥善保管你的管理员 API 密钥。

​

文档助手 API 密钥

文档助手 API 密钥用于 Generate assistant message 和 Search documentation 端点。

文档助手 API 密钥以 mint_dsc_ 为前缀。

文档助手 API 的“密钥”（key）是服务器端令牌，应当保密。

文档助手 API 的“令牌”（token）是公共令牌，可在前端代码中引用。

使用文档助手 API 令牌进行调用可能产生费用：要么消耗你的 AI 文档助手额度，要么产生超额费用。