mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
cdxker
24 lines
883 B
Plaintext
24 lines
883 B
Plaintext
---
|
|
title: "Create agent job"
|
|
description: "Create an agent job that runs in the background and automatically creates a pull request with documentation changes."
|
|
openapi: /admin-openapi.json POST /v2/agent/{projectId}/job
|
|
keywords: ["agent job", "create", "automation", "automate"]
|
|
---
|
|
|
|
This endpoint creates a background agent job. The job runs asynchronously — use the [get agent job](/api/agent/v2/get-agent-job) endpoint to poll for status updates.
|
|
|
|
If the agent edits files successfully, a pull request is automatically created and the `prLink` field is populated in the job response.
|
|
|
|
## Rate limits
|
|
|
|
- 100 uses per Mintlify project per hour
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
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"}'
|
|
```
|