mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
b4c08f5597
- Updated discovery-openapi.json - Updated es/admin-openapi.json - Updated es/discovery-openapi.json - Updated fr/admin-openapi.json - Updated fr/discovery-openapi.json - Updated zh/admin-openapi.json - Updated zh/discovery-openapi.json - Updated api/introduction.mdx - Updated admin-openapi.json - Updated openapi.json - Updated es/api/introduction.mdx - Updated fr/api/introduction.mdx - Updated zh/api/introduction.mdx - Deleted api/agent/create-agent-job.mdx - Deleted api/agent/get-agent-job.mdx - Deleted api/agent/get-all-jobs.mdx - Deleted api/agent/v2/create-agent-job.mdx - Deleted api/agent/v2/get-agent-job.mdx - Deleted api/agent/v2/send-message.mdx - Deleted api/analytics/assistant-caller-stats.mdx - Deleted api/analytics/assistant-conversations.mdx - Deleted api/analytics/feedback-by-page.mdx - Deleted api/analytics/feedback.mdx - Deleted api/analytics/searches.mdx - Deleted api/analytics/views.mdx - Deleted api/analytics/visitors.mdx - Deleted api/assistant/create-assistant-message-v2.mdx - Deleted api/assistant/create-assistant-message.mdx - Deleted api/assistant/get-page-content.mdx - Deleted api/assistant/search.mdx - Deleted api/preview/trigger.mdx - Deleted api/update/status.mdx - Deleted api/update/trigger.mdx - Deleted es/api/agent/create-agent-job.mdx - Deleted es/api/agent/get-agent-job.mdx - Deleted es/api/agent/get-all-jobs.mdx - Deleted es/api/agent/v2/create-agent-job.mdx - Deleted es/api/agent/v2/get-agent-job.mdx - Deleted es/api/agent/v2/send-message.mdx - Deleted es/api/analytics/assistant-caller-stats.mdx - Deleted es/api/analytics/assistant-conversations.mdx - Deleted es/api/analytics/feedback-by-page.mdx - Deleted es/api/analytics/feedback.mdx - Deleted es/api/analytics/searches.mdx - Deleted es/api/analytics/views.mdx - Deleted es/api/analytics/visitors.mdx - Deleted es/api/assistant/create-assistant-message-v2.mdx - Deleted es/api/assistant/create-assistant-message.mdx - Deleted es/api/assistant/get-page-content.mdx - Deleted es/api/assistant/search.mdx - Deleted es/api/preview/trigger.mdx - Deleted es/api/update/status.mdx - Deleted es/api/update/trigger.mdx - Deleted fr/api/agent/create-agent-job.mdx - Deleted fr/api/agent/get-agent-job.mdx - Deleted fr/api/agent/get-all-jobs.mdx - Deleted fr/api/agent/v2/create-agent-job.mdx - Deleted fr/api/agent/v2/get-agent-job.mdx - Deleted fr/api/agent/v2/send-message.mdx - Deleted fr/api/analytics/assistant-caller-stats.mdx - Deleted fr/api/analytics/assistant-conversations.mdx - Deleted fr/api/analytics/feedback-by-page.mdx - Deleted fr/api/analytics/feedback.mdx - Deleted fr/api/analytics/searches.mdx - Deleted fr/api/analytics/views.mdx - Deleted fr/api/analytics/visitors.mdx - Deleted fr/api/assistant/create-assistant-message-v2.mdx - Deleted fr/api/assistant/create-assistant-message.mdx - Deleted fr/api/assistant/get-page-content.mdx - Deleted fr/api/assistant/search.mdx - Deleted fr/api/preview/trigger.mdx - Deleted fr/api/update/status.mdx - Deleted fr/api/update/trigger.mdx - Deleted zh/api/agent/create-agent-job.mdx - Deleted zh/api/agent/get-agent-job.mdx - Deleted zh/api/agent/get-all-jobs.mdx - Deleted zh/api/agent/v2/create-agent-job.mdx - Deleted zh/api/agent/v2/get-agent-job.mdx - Deleted zh/api/agent/v2/send-message.mdx - Deleted zh/api/analytics/assistant-caller-stats.mdx - Deleted zh/api/analytics/assistant-conversations.mdx - Deleted zh/api/analytics/feedback-by-page.mdx - Deleted zh/api/analytics/feedback.mdx - Deleted zh/api/analytics/searches.mdx - Deleted zh/api/analytics/views.mdx - Deleted zh/api/analytics/visitors.mdx - Deleted zh/api/assistant/create-assistant-message-v2.mdx - Deleted zh/api/assistant/create-assistant-message.mdx - Deleted zh/api/assistant/get-page-content.mdx - Deleted zh/api/assistant/search.mdx - Deleted zh/api/preview/trigger.mdx - Deleted zh/api/update/status.mdx - Deleted zh/api/update/trigger.mdx - Updated docs.json - Updated es.json - Updated fr.json - Updated zh.json Mintlify-Source: dashboard-editor
68 lines
4.9 KiB
Plaintext
68 lines
4.9 KiB
Plaintext
---
|
||
title: "简介"
|
||
description: "使用 Mintlify REST API 触发部署、嵌入 AI 助手、导出 Analytics 数据，并以编程方式管理文档。"
|
||
keywords: ["REST API", "endpoints", "API keys"]
|
||
boost: 3
|
||
---
|
||
|
||
Mintlify 的 REST（Representational State Transfer）API 让你可以以编程方式与文档交互、触发更新、嵌入 AI 驱动的聊天体验，并导出 Analytics 数据。
|
||
|
||
<div id="endpoints">
|
||
## 端点
|
||
</div>
|
||
|
||
- [Trigger update](/zh/api/admin/trigger-update)：在需要时触发您站点的更新。
|
||
- [Get update status](/zh/api/admin/get-update-status)：获取某次更新的状态以及与您的文档相关的其他详细信息。
|
||
- [Trigger preview deployment](/zh/api/admin/trigger-preview-deployment)：为特定分支创建或更新预览部署。
|
||
- [Create agent job](/zh/api/agent/create-agent-job)：创建一个代理任务以自动编辑您的文档。
|
||
- [Get agent job](/zh/api/agent/get-agent-job)：获取特定代理任务的详细信息和状态。
|
||
- [Send follow-up message](/zh/api/agent/send-follow-up-message)：向已有的代理任务发送后续消息。
|
||
- [Create assistant message](/zh/api/assistant/create-assistant-message)：将基于您的文档训练的 AI 助手嵌入到任意您选择的应用中。
|
||
- [搜索文档](/zh/api/assistant/search-documentation)：搜索您的文档。
|
||
- [获取页面内容](/zh/api/assistant/get-page-content)：检索文档页面的完整文本内容。
|
||
- [获取用户反馈](/zh/api/analytics/get-feedback)：从您的文档中导出用户反馈。
|
||
- [获取 AI 助手会话](/zh/api/analytics/get-assistant-conversations)：导出 AI 助手的会话历史。
|
||
- [Get assistant caller stats](/zh/api/analytics/get-assistant-caller-stats)：获取按调用方类型划分的助手查询次数明细。
|
||
|
||
<div id="common-use-cases">
|
||
### 常见用例
|
||
</div>
|
||
|
||
- **自动化部署**：使用 [Trigger update](/zh/api/admin/trigger-update) 和 [Get update status](/zh/api/admin/get-update-status)，在设定的时间间隔或当特定事件发生时触发站点更新。
|
||
- **CI/CD 集成**：在代码变更时，将文档更新作为部署流水线的一部分来执行，使用 [Trigger update](/zh/api/admin/trigger-update)。
|
||
- **预览部署**：使用 [Trigger preview deployment](/zh/api/admin/trigger-preview-deployment)，在 CI/CD 流水线中以编程方式创建或更新预览部署。
|
||
- **自定义集成**：使用 [Create assistant message](/zh/api/assistant/create-assistant-message)、[Search documentation](/zh/api/assistant/search-documentation) 和 [Get page content](/zh/api/assistant/get-page-content)，将 AI 助手嵌入到你的产品、支持门户或内部工具中。
|
||
- **自动化编辑**：使用 agent 任务，以编程方式大规模更新文档，配合 [Create agent job](/zh/api/agent/create-agent-job)、[Get agent job](/zh/api/agent/get-agent-job) 和 [Send follow-up message](/zh/api/agent/send-follow-up-message)。
|
||
- **Analytics 导出**：使用 [Get user feedback](/zh/api/analytics/get-feedback)、[Get assistant conversations](/zh/api/analytics/get-assistant-conversations) 和 [Get assistant caller stats](/zh/api/analytics/get-assistant-caller-stats)，导出反馈、助手会话和调用方统计数据以进行外部分析。
|
||
|
||
<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 对发送到 [Trigger update](/zh/api/admin/trigger-update)、[Get update status](/zh/api/admin/get-update-status)、[Trigger preview deployment](/zh/api/admin/trigger-preview-deployment)、[Create agent job](/zh/api/agent/create-agent-job)、[Get agent job](/zh/api/agent/get-agent-job)、[Send follow-up message](/zh/api/agent/send-follow-up-message)、[Get user feedback](/zh/api/analytics/get-feedback)、[Get assistant conversations](/zh/api/analytics/get-assistant-conversations) 和 [Get assistant caller stats](/zh/api/analytics/get-assistant-caller-stats) 的请求进行身份验证。
|
||
|
||
管理员 API key 以 `mint_` 前缀开头。
|
||
|
||
管理员 API key 是一个服务器端密钥。不要在客户端代码中暴露它。
|
||
|
||
<div id="assistant-api-key">
|
||
### Assistant API key
|
||
</div>
|
||
|
||
使用 assistant API key 对发往 [Create assistant message](/zh/api/assistant/create-assistant-message)、[Search documentation](/zh/api/assistant/search-documentation) 和 [Get page content](/zh/api/assistant/get-page-content) 端点的请求进行认证。
|
||
|
||
assistant API key 以 `mint_dsc_` 前缀开头。
|
||
|
||
assistant API key 是一个公共令牌，你可以在前端代码中引用。
|
||
|
||
<Note>
|
||
使用 assistant API token 进行的调用可能会产生费用：可能会消耗你的助手额度，或产生超额费用。
|
||
</Note> |