mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
cdxker
24 lines
1.0 KiB
Plaintext
24 lines
1.0 KiB
Plaintext
---
|
|
title: "Create agent job (v1)"
|
|
description: "Deprecated. Create an agent job to automate documentation updates, with automatic branch creation and pull request generation."
|
|
openapi: /admin-openapi.json POST /v1/agent/{projectId}/job
|
|
keywords: [ "agent job", "create", "automation", "automate" ]
|
|
tag: "deprecated"
|
|
---
|
|
|
|
<Warning>This endpoint is deprecated. Use the [v2 create agent job](/api/agent/v2/create-agent-job) endpoint instead.</Warning>
|
|
|
|
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.
|