Overview

Automate documentation maintenance with Mintlify workflows. Run the agent on a schedule or in response to GitHub and GitLab repository pushes.

Workflows are in beta. Features, availability, and pricing are subject to change.

Workflows run the agent automatically on a schedule or in response to pushes to a repository. Each workflow defines a prompt for the agent and a trigger for when to run it. Workflows support both GitHub and GitLab repositories.

When a workflow runs, the agent clones any specified repositories as context and follows the prompt.

Use workflows that run on a schedule to automate recurring tasks, like publishing changelogs or checking for grammar and style issues.

Use workflows that run on push events to automate reactive maintenance tasks, like updating API reference documentation or identifying documentation updates needed for new features.

Trigger types

Workflows support two trigger types.

• Schedule (cron) — Run on a recurring daily, weekly, or monthly schedule. Workflows queue within 10 minutes of the scheduled time.
• Push events — Run when changes land on the watched branch of a trigger repository, either through a pull request merge or a direct push to the default branch. The agent receives the merged or pushed commit as context for the run.

You cannot combine trigger types in a single workflow. Each workflow has exactly one trigger.

When a push event triggers a workflow, the agent runs once per change. If the same commit lands on the default branch through both a pull request merge and a direct push, the workflow only runs once.

Usage limits

Each workflow can run up to 500 times per day. Hobby plan projects have an additional limit of 100 total workflow runs per month. Runs that fail do not count towards these limits.