{
  "openapi": "3.0.1",
  "info": {
    "title": "Mintlify External API",
    "description": "An API for Mintlify documentation management and resource access.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.mintlify.com/v1"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "x-mcp": {
    "enabled": true
  },
  "paths": {
    "/project/update/{projectId}": {
      "post": {
        "summary": "Trigger deployment",
        "description": "Queues a deployment update for your documentation project. Returns a status ID that can be used to track the update progress. The update is triggered from your configured deployment branch.\n\nAuthenticate with an admin API key.",
        "parameters": [
          {
            "name": "projectId",
            "in": "path",
            "description": "Your project ID. Can be copied from the [API keys](https://app.mintlify.com/settings/organization/api-keys) page in your dashboard.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "The update was queued. Use the returned `statusId` to track its progress.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "statusId": {
                      "type": "string",
                      "description": "The status ID of the triggered updated."
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The project ID is malformed."
          },
          "401": {
            "description": "The API key is missing or invalid, or your plan doesn't include API access."
          },
          "403": {
            "description": "Your API key doesn't have write access, or your request came from an IP address that isn't on your API key's allowlist."
          },
          "404": {
            "description": "The project doesn't exist or doesn't belong to your organization."
          },
          "429": {
            "description": "You exceeded the rate limit of 10 requests per 10 seconds per organization. This limit is shared with the trigger deployment, trigger automation, and automation webhook endpoints."
          },
          "500": {
            "description": "The update couldn't be queued. Retry the request. If the error continues, contact support."
          }
        }
      }
    },
    "/project/update-status/{statusId}": {
      "get": {
        "summary": "Get deployment status",
        "description": "Retrieves the status of a deployment update by its status ID.\n\nAuthenticate with an admin API key.",
        "parameters": [
          {
            "name": "statusId",
            "in": "path",
            "description": "The status ID of a triggered update.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The status of the update.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "_id": {
                      "type": "string",
                      "description": "The status ID of the triggered updated."
                    },
                    "projectId": {
                      "type": "string",
                      "description": "The documentation project ID."
                    },
                    "createdAt": {
                      "type": "string",
                      "description": "An ISODate with the specified datetime in UTC"
                    },
                    "endedAt": {
                      "type": "string",
                      "description": "An ISODate with the specified datetime in UTC"
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "queued",
                        "in_progress",
                        "success",
                        "failure"
                      ],
                      "description": "The status of the update."
                    },
                    "summary": {
                      "type": "string",
                      "description": "Summary of the status of the update"
                    },
                    "logs": {
                      "type": "array",
                      "description": "An array of logs.",
                      "items": {
                        "type": "string"
                      }
                    },
                    "subdomain": {
                      "type": "string",
                      "description": "The subdomain of the docs being updated."
                    },
                    "screenshot": {
                      "type": "string",
                      "description": "A screenshot of the docs."
                    },
                    "screenshotLight": {
                      "type": "string",
                      "description": "A screenshot of the docs."
                    },
                    "screenshotDark": {
                      "type": "string",
                      "description": "A screenshot of the docs in dark mode."
                    },
                    "author": {
                      "type": "object",
                      "description": "The author of the update.",
                      "nullable": true,
                      "properties": {
                        "name": {
                          "type": "string",
                          "description": "The name of the author."
                        },
                        "avatarUrl": {
                          "type": "string",
                          "description": "URL of the author's avatar image."
                        },
                        "githubUserId": {
                          "type": "number",
                          "description": "The author's GitHub user ID."
                        }
                      }
                    },
                    "commit": {
                      "type": "object",
                      "description": "The commit details",
                      "properties": {
                        "sha": {
                          "type": "string",
                          "description": "The SHA of the commit."
                        },
                        "ref": {
                          "type": "string",
                          "description": "The ref of the commit."
                        },
                        "message": {
                          "type": "string",
                          "description": "The commit message."
                        },
                        "filesChanged": {
                          "type": "object",
                          "description": "Details on the changed files.",
                          "properties": {
                            "added": {
                              "type": "array",
                              "description": "New files added.",
                              "items": {
                                "type": "string"
                              }
                            },
                            "modified": {
                              "type": "array",
                              "description": "Existing files that were modified.",
                              "items": {
                                "type": "string"
                              }
                            },
                            "removed": {
                              "type": "array",
                              "description": "Files that were removed.",
                              "items": {
                                "type": "string"
                              }
                            }
                          }
                        }
                      }
                    },
                    "source": {
                      "type": "string",
                      "description": "The source of the update trigger.",
                      "enum": [
                        "internal",
                        "github-app-installation",
                        "api",
                        "github",
                        "dashboard",
                        "gitlab",
                        "onboarding"
                      ]
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "The API key is missing or invalid, the update belongs to a project outside your organization, or your plan doesn't include API access."
          },
          "403": {
            "description": "Your request came from an IP address that isn't on your API key's allowlist."
          },
          "404": {
            "description": "No update exists with this status ID."
          },
          "429": {
            "description": "You exceeded the rate limit of 20 requests per 10 seconds per organization."
          },
          "500": {
            "description": "The project for this update no longer exists."
          }
        }
      }
    },
    "/project/preview/{projectId}": {
      "post": {
        "summary": "Trigger preview deployment",
        "description": "Creates or updates a preview deployment for a specific branch. If a preview already exists for the branch, it triggers a redeployment. Returns a status ID to track progress and the preview URL.\n\nAuthenticate with an admin API key.",
        "parameters": [
          {
            "name": "projectId",
            "in": "path",
            "description": "Your project ID. Can be copied from the [API keys](https://app.mintlify.com/settings/organization/api-keys) page in your dashboard.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "branch"
                ],
                "properties": {
                  "branch": {
                    "type": "string",
                    "description": "The name of the Git branch to create a preview deployment for.",
                    "minLength": 1
                  },
                  "auth": {
                    "description": "Access restriction to apply to the preview. Omit to leave the preview's current access settings unchanged. Requires a plan that includes preview authentication, and your site must have authentication or preview authentication enabled.",
                    "oneOf": [
                      {
                        "type": "object",
                        "title": "Password",
                        "required": [
                          "type",
                          "password"
                        ],
                        "additionalProperties": false,
                        "properties": {
                          "type": {
                            "type": "string",
                            "enum": [
                              "password"
                            ],
                            "description": "Password-protect the preview. Anyone with the password can view it."
                          },
                          "password": {
                            "type": "string",
                            "minLength": 8,
                            "description": "The password reviewers enter to view the preview. Must be at least 8 characters. Replaces any existing password on the preview."
                          }
                        }
                      },
                      {
                        "type": "object",
                        "title": "Dashboard login",
                        "required": [
                          "type"
                        ],
                        "additionalProperties": false,
                        "properties": {
                          "type": {
                            "type": "string",
                            "enum": [
                              "mintlify"
                            ],
                            "description": "Restrict the preview to members of your organization signed in to Mintlify."
                          }
                        }
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Preview deployment queued successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "statusId": {
                      "type": "string",
                      "description": "The status ID for tracking the preview deployment. Use this with the [Get deployment status](/api/update/status) endpoint."
                    },
                    "previewUrl": {
                      "type": "string",
                      "description": "The URL where the preview deployment is hosted."
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid request body. The `branch` field is required, and `auth` must match one of the supported shapes.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "The API key is missing or invalid, or your plan doesn't include API access."
          },
          "403": {
            "description": "Preview deployments aren't available on your current plan, `auth` was provided and preview deployment authentication isn't available on your current plan, your API key doesn't have write access, or your request came from an IP address that isn't on your API key's allowlist.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The project doesn't exist or doesn't belong to your organization."
          },
          "409": {
            "description": "`auth` was provided but authentication is not enabled. Enable authentication or preview authentication for your project, and make sure authentication is enabled on the preview, before setting preview auth.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "You exceeded the rate limit of 5 requests per minute per organization."
          },
          "500": {
            "description": "Mintlify failed to update the preview's authentication settings.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/workflow/{projectId}/{workflowSchemaId}/trigger": {
      "post": {
        "summary": "Trigger automation",
        "description": "Triggers a scheduled automation to run immediately, instead of waiting for its next scheduled time. Useful for running automations from CI/CD pipelines, like a GitHub Action that runs on every merge to your default branch. Only scheduled (custom schedule) automations can be triggered. The run picks up changes since the last completed run, identical to a regular scheduled run.\n\nAuthenticate with an admin API key.",
        "parameters": [
          {
            "name": "projectId",
            "in": "path",
            "description": "Your project ID. Can be copied from the [API keys](https://app.mintlify.com/settings/organization/api-keys) page in your dashboard.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "workflowSchemaId",
            "in": "path",
            "description": "The ID of the automation to trigger. Can be copied from the automation's settings panel in your [Automations](https://app.mintlify.com/settings/project/automations) settings.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "Automation run queued successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "schemaId": {
                      "type": "string",
                      "description": "The ID of the triggered automation."
                    },
                    "instanceId": {
                      "type": "string",
                      "description": "The ID of the queued automation run. Appears on the **Runs** tab of your [Automations](https://app.mintlify.com/settings/project/automations?tab=runs) settings."
                    },
                    "jobId": {
                      "type": "string",
                      "description": "The ID of the background job processing the run."
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid request. The automation ID is malformed, the automation is not active, or the automation is not configured with a custom schedule.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "The API key is missing or invalid, or your plan doesn't include API access or automations."
          },
          "403": {
            "description": "Your API key doesn't have write access, or your request came from an IP address that isn't on your API key's allowlist."
          },
          "404": {
            "description": "The project doesn't exist or doesn't belong to your organization, or the automation doesn't exist or doesn't belong to this project.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "You exceeded the rate limit of 10 requests per 10 seconds per organization. This limit is shared with the trigger deployment, trigger automation, and automation webhook endpoints."
          },
          "500": {
            "description": "An unexpected server error occurred. Retry the request. If the error continues, contact support."
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "The Authorization header expects a Bearer token. Use an admin API key. This is a server-side secret key. Generate one on the [API keys page](https://app.mintlify.com/settings/organization/api-keys) in your dashboard."
      }
    }
  }
}