跳转到主要内容
POST
/
agent
/
{projectId}
/
job
Create agent job
curl --request POST \
  --url https://api.mintlify.com/v1/agent/{projectId}/job \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "branch": "<string>",
  "messages": [
    {
      "role": "system",
      "content": "<string>"
    }
  ],
  "asDraft": true
}
'
"<string>"
此端点会根据提供的消息和 branch 信息创建一个代理任务。该任务异步执行，并以流式方式返回包含执行详情与结果的响应。 如果 branch 不存在，代理会自动创建该 branch。若文件编辑成功，任务结束时会自动创建一个拉取请求（PR；亦称“合并请求”/Merge Request）。

​
速率限制

代理 API 的限制如下：
  • 每个 Mintlify 项目每小时最多可调用 100 次

​
建议用法

为获得最佳效果，请使用 ai-sdk 的 useChat 钩子 来发送请求并处理响应。

Authorizations

​
Authorization
string
header
required

The Authorization header expects a Bearer token. Create an Admin API Key here.

Path Parameters

​
projectId
string
required

Your project ID. Can be copied from the API keys page in your dashboard.

Body

application/json
​
branch
string
required

The name of the Git branch that the agent should work on, will be automatically created if it doesn't exist

​
messages
object[]
required

A list of previous messages to provide to the agent.

​
asDraft
boolean
default:true

Control whether the pull request is created in draft or non-draft mode. When true, creates a draft pull request. When false, creates a regular (non-draft) pull request ready for review.

Response

200 - text/plain

Agent job created successfully (streaming response). X-Session-Id Header is sent back in the response

Streaming response containing the agent job execution details and results.