触发自动化

立即触发计划自动化运行，而无需等待其下一次预定时间。适合从 CI/CD 流水线中运行自动化，例如在每次合并到默认分支时运行的 GitHub Action。仅支持触发计划（自定义计划）自动化。该次运行会处理自上次完成运行以来的变更，与常规计划运行完全相同。

POST /workflow/{projectId}/{workflowSchemaId}/trigger

触发自动化

cURL

curl --request POST \
  --url https://api.mintlify.com/v1/workflow/{projectId}/{workflowSchemaId}/trigger \
  --header 'Authorization: Bearer <token>'

202

{
  "schemaId": "<string>",
  "instanceId": "<string>",
  "jobId": "<string>"
}

使用此端点可按需触发计划自动化，而无需等待其下一次预定运行。该自动化的行为与常规计划运行完全相同：会处理自上次完成运行以来发生的所有变更。

此端点仅支持配置为 Custom schedule 触发器的自动化。对于使用其他触发器（如 Code change 或 Content update）的自动化，请求会返回 400 错误。

​

用例

• CI/CD 流水线：在每次合并到 main 时运行 Update from code changes 自动化，使文档按发布节奏更新，而不是按固定计划。
• 发布事件：在你打出发布标签时运行 Draft changelog 自动化，使变更日志与发布同时起草。
• 自定义工具：从内部工具、Slack 命令或已有的计划任务中触发自动化。

​

查找自动化 ID

在控制台的 Automations 页面，从自动化的设置面板中复制自动化 ID。

​

示例

每当代码合并到 main 时，从 GitHub Action 触发自动化：

.github/workflows/trigger-docs.yml

on:
  push:
    branches: [main]

jobs:
  trigger:
    runs-on: ubuntu-latest
    steps:
      - run: |
          curl -fsS -X POST \
            "https://api.mintlify.com/v1/workflow/$PROJECT_ID/$WORKFLOW_ID/trigger" \
            -H "Authorization: Bearer ${{ secrets.MINTLIFY_API_KEY }}"
        env:
          PROJECT_ID: ${{ vars.MINTLIFY_PROJECT_ID }}
          WORKFLOW_ID: ${{ vars.MINTLIFY_WORKFLOW_ID }}

​

速率限制

此端点与 Trigger update 共享速率限制：每个组织每分钟最多 5 个请求。触发的运行与计划运行按相同速率消耗积分。

授权

Authorization · string · header · 必填

Authorization 请求头需要使用 Bearer token。请使用以 mint_ 为前缀的管理员 API key。该 key 是仅供服务端使用的机密密钥。你可以在控制台的 API keys 页面 中生成一个。

路径参数

projectId · string · 必填

你的项目 ID。可在控制台的 API keys 页面中复制。

workflowSchemaId · string · 必填

要触发的自动化的 ID。可在控制台的 Automations 页面，从自动化的设置面板中复制。

响应

202

application/json

自动化运行已成功加入队列。

schemaId · string

被触发的自动化的 ID。

instanceId · string

已入队自动化运行的 ID。会出现在 Automation Runs 页面的运行历史中。

jobId · string

处理此次运行的后台任务 ID。