用途:Mintlify API 用于以编程方式管理 Mintlify 文档站点,覆盖部署管理、构建触发和站点元数据查询。
认证方式:所有 API 请求都需要在 Authorization 头中传入 API Key,格式为 Authorization: Bearer <your-api-key>。API Key 在 Mintlify 控制台的 Settings > API Keys 中生成。
主要能力:一、触发部署,当代码库变更不经过 Git push 事件时,可编程触发文档重新构建;二、查询站点元数据,获取文档站点信息,包括部署状态、已配置域名和导航结构;三、管理预览部署,为 pull request 和分支创建与管理预览部署,以便文档变更上线前进行审阅。
使用方式:资料未提供具体接口路径、请求参数、响应格式或代码示例,仅说明使用 REST 风格调用并需携带 API Key。具体调用细节需参考官方 API 参考文档。
适用场景:适合需要在 CI/CD 或其他自动化流程中控制文档构建与部署、检查站点部署状态或审阅分支文档改动的团队。
限制:资料未说明接口的速率限制、配额、权限细分、错误码或是否收费,这些信息暂未提供。
资源:官方提供了 API 参考、控制台和部署指南等入口。