Skip to content
Mintlify
Agent

Create agent job

POST/v2/agent/{projectId}/job

Creates a new agent job that runs in the background. The job processes the prompt asynchronously — poll the get job endpoint to track progress. If the agent edits files successfully, a pull request is automatically created.

This endpoint creates a background agent job. The job runs asynchronously. Use the get agent job endpoint to poll for status updates.

If the agent edits files successfully, Mintlify creates a pull request and populates the prLink field in the job response.

Rate limits

  • 100 uses per Mintlify project per hour

Usage

curl -X POST https://api.mintlify.com/v2/agent/{projectId}/job \
  -H "Authorization: Bearer mint_xxxxx" \
  -H "Content-Type: application/json" \
  -d '{"prompt": "Add a quickstart guide for the Python SDK"}'
Ctrl+I

On this page