mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
locadex-agent[bot]
19d89bf8eb
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
63 lines
4.0 KiB
Plaintext
63 lines
4.0 KiB
Plaintext
---
|
|
title: "简介"
|
|
description: "触发更新、嵌入 AI 助手、导出 Analytics 等"
|
|
keywords: ["REST API", "endpoints", "API keys"]
|
|
---
|
|
|
|
Mintlify 的 REST API 让你可以以编程方式与文档交互、触发更新、嵌入 AI 驱动的聊天体验，并导出 Analytics 数据。
|
|
|
|
<div id="endpoints">
|
|
## 端点
|
|
</div>
|
|
|
|
* [触发更新](/zh/api-reference/update/trigger): 按需触发你的网站更新。
|
|
* [获取更新状态](/zh/api-reference/update/status): 获取一次更新的状态以及你文档的其他详细信息。
|
|
* [创建代理任务](/zh/api-reference/agent/create-agent-job): 创建代理任务以自动编辑你的文档。
|
|
* [获取代理任务](/zh/api-reference/agent/get-agent-job): 获取特定代理任务的详细信息和状态。
|
|
* [获取所有代理任务](/zh/api-reference/agent/get-all-jobs): 获取某个 domain 的所有代理任务。
|
|
* [生成 AI 助手消息](/zh/api-reference/assistant/create-assistant-message): 将基于你的文档训练的 AI 助手嵌入到任意应用中。
|
|
* [搜索文档](/zh/api-reference/assistant/search): 在你的文档中进行搜索。
|
|
* [获取用户反馈](/zh/api-reference/analytics/feedback): 导出文档中的用户反馈数据。
|
|
* [获取 AI 助手会话](/zh/api-reference/analytics/assistant-conversations): 导出 AI 助手的对话历史记录。
|
|
|
|
<div id="common-use-cases">
|
|
### 常见用例
|
|
</div>
|
|
|
|
* **自动化部署**：使用 [Trigger update](/zh/api-reference/update/trigger) 和 [Get update status](/zh/api-reference/update/status)，在预设时间间隔或指定事件发生时触发站点更新。
|
|
* **CI/CD 集成**：将文档更新集成到部署流水线中，在代码变更时通过 [Trigger update](/zh/api-reference/update/trigger) 触发更新。
|
|
* **自定义集成**：使用 [Generate assistant message](/zh/api-reference/assistant/create-assistant-message) 和 [Search documentation](/zh/api-reference/assistant/search)，将 AI 助手嵌入到你的产品、支持门户或内部工具中。
|
|
* **自动化编辑**：使用 agent 作业以编程方式大规模更新文档，配合 [Create agent job](/zh/api-reference/agent/create-agent-job)、[Get agent job](/zh/api-reference/agent/get-agent-job) 和 [Get all agent jobs](/zh/api-reference/agent/get-all-jobs)。
|
|
* **Analytics 导出**：使用 [Get user feedback](/zh/api-reference/analytics/feedback) 和 [Get assistant conversations](/zh/api-reference/analytics/assistant-conversations) 导出用户反馈和 AI 助手对话数据，用于外部分析。
|
|
|
|
<div id="authentication">
|
|
## 认证
|
|
</div>
|
|
|
|
在控制台的 [API keys 页面](https://dashboard.mintlify.com/settings/organization/api-keys)生成 API key。每个 API key 都属于一个组织，你可以在同一组织内的多个部署中使用这些 API key。
|
|
|
|
每个组织每小时最多可创建 10 个 API key。
|
|
|
|
<div id="admin-api-key">
|
|
### 管理员 API key
|
|
</div>
|
|
|
|
使用管理员 API key 对发送到 [触发更新](/zh/api-reference/update/trigger)、[获取更新状态](/zh/api-reference/update/status)、[创建代理任务](/zh/api-reference/agent/create-agent-job)、[获取代理任务](/zh/api-reference/agent/get-agent-job)、[获取所有代理任务](/zh/api-reference/agent/get-all-jobs)、[获取用户反馈](/zh/api-reference/analytics/feedback) 和 [获取 AI 助手会话](/zh/api-reference/analytics/assistant-conversations) 的请求进行身份验证。
|
|
|
|
管理员 API key 以 `mint_` 前缀开头。
|
|
|
|
管理员 API key 是一个服务器端密钥。不要在客户端代码中暴露它。
|
|
|
|
<div id="assistant-api-key">
|
|
### Assistant API key
|
|
</div>
|
|
|
|
使用 assistant API key 对发往 [生成助手消息](/zh/api-reference/assistant/create-assistant-message) 和 [搜索文档](/zh/api-reference/assistant/search) 端点的请求进行认证。
|
|
|
|
assistant API key 以 `mint_dsc_` 前缀开头。
|
|
|
|
assistant API key 是一个公共令牌，你可以在前端代码中引用。
|
|
|
|
<Note>
|
|
使用 assistant API token 进行的调用可能会产生费用：可能会消耗你的助手额度，或产生超额费用。
|
|
</Note> |