mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
3dc3852b7a
* Improve SEO descriptions across 47 pages Curated descriptions from two bot-generated PRs (#3908, #3949), selecting the best approach for each page: - Added missing title and description frontmatter to 10 API reference pages - Benefit-focused descriptions for integration pages (not implementation-heavy) - Accurate REST-aligned titles for API endpoints (Export, List, Trigger, etc.) - Expanded short descriptions to 50–160 character range throughout Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * copyedit * Update custom-domain.mdx * Fix analytics API page titles to match spec summaries "Export" was inaccurate — spec uses "Get" for both endpoints. Also updated descriptions to use "Retrieve" for consistency. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
21 lines
897 B
Plaintext
21 lines
897 B
Plaintext
---
|
|
title: "Create agent job"
|
|
description: "Create an agent job to automate documentation updates, with automatic branch creation and pull request generation."
|
|
openapi: /admin-openapi.json POST /agent/{projectId}/job
|
|
keywords: [ "agent job", "create", "automation", "automate" ]
|
|
---
|
|
|
|
This endpoint creates an agent job based on provided messages and branch information. The job executes asynchronously and returns a streaming response with the execution details and results.
|
|
|
|
If a branch doesn't exist, the agent creates one. If files are edited successfully, a pull request is automatically created at the end of the job.
|
|
|
|
## Rate limits
|
|
|
|
The agent API has the following limits:
|
|
|
|
- 100 uses per Mintlify project per hour
|
|
|
|
## Suggested usage
|
|
|
|
For best results, use the [useChat hook from ai-sdk](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat#usechat) to send requests and handle responses.
|