简介

触发更新、嵌入 AI 助手等

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

​

端点

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

​

认证

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

​

Admin API key

Admin API key 用于 Trigger update 和 Get update status 端点。

Admin API key 以 mint_ 为前缀。请妥善保管你的 Admin API key。

​

Assistant API key

Assistant API key 用于 Generate assistant message 和 Search documentation 端点。

Assistant API key 以 mint_dsc_ 为前缀。

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

Assistant API 的 token 是公开令牌，可以在你的前端代码中引用。

使用 Assistant API token 的调用可能产生费用：要么消耗你的 AI 助手额度，要么产生超额费用。