Workflows overview

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

Workflows run the agent automatically on a schedule or in response to changes in 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 reads your project content and any connected repositories, then follows the prompt to make updates.

Use workflows that run on a schedule for recurring tasks, like publishing changelogs or auditing SEO metadata.

Use workflows that trigger on content or code changes for reactive maintenance, like translations or updating content when source code changes.

Trigger types

Workflows support three trigger types.

• Content update — Run when content changes push to your Mintlify project repository, including pull request merges and direct pushes.
• Code change — Run when a pull request merges in a connected source code repository.
• Custom schedule — Run on a recurring schedule. Workflows queue within 10 minutes of the scheduled time.

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

Usage limits

Workflow runs count toward your credit usage. See your credit usage, set overages, and manage your credit package on the Usage page of your dashboard.

Each workflow can run up to 500 times per day. Runs that fail do not count toward this limit.

Next steps

Predefined workflows

Reference for all predefined workflows: triggers, update modes, and required configuration.

Manage workflows

Turn on predefined workflows and configure triggers, update mode, and context.

Create a custom workflow

Build a workflow with your own trigger, instructions, and context repositories.

Learn best practices

Choose the right trigger, write effective instructions, and review results.