MintlifyInstall

Summary

Update or create documentation on a specified Git branch using the Mintlify AI agent by providing instructions describing the desired documentation changes.

Inputs

• Branch Name (required) — The git branch where the documentation changes should be applied, e.g., 'main'.
• Instructions (required) — Text instructions telling the Mintlify AI agent what documentation changes to perform.

Output shape

a JSON object containing the status of the update request including success status, a job ID for tracking, the branch name, the prompt used, and a status string ('created').

The output includes a 'jobId' header identifier that can be used subsequently to query the status and details of this documentation update job via Mintlify's API. Errors during the update are handled and returned according to node settings (e.g., continueOnFail). No direct documentation content is returned.