创建代理任务 (v1)

已废弃。创建一个代理任务，用于自动更新文档，并自动创建分支和拉取请求。

POST /v1/agent/{projectId}/job

创建代理任务（v1）

cURL

curl --request POST \
  --url https://api.mintlify.com/v1/agent/{projectId}/job \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {
      "role": "system",
      "content": "<string>"
    }
  ],
  "branch": "<string>",
  "asDraft": false,
  "model": "sonnet"
}
'

200

"<string>"

此端点已废弃。请改用 v2 创建代理任务 端点。

此端点会根据提供的消息和分支信息创建一个代理任务。该任务异步执行，并以流式方式返回包含执行详情与结果的响应。

如果分支不存在，代理会自动创建该分支。若文件编辑成功，任务结束时会自动创建一个拉取请求。

​

速率限制

代理 API 的限制如下：

• 每个 Mintlify 项目每小时最多可调用 100 次

​

建议用法

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

授权

Authorization · string · header · 必填

Authorization 头部需要 Bearer 令牌。请使用以 mint_ 为前缀的管理员 API 密钥。这是服务端使用的机密凭证。你可以在控制台的 API keys 页面 中生成一个。

路径参数

projectId · string · 必填

你的项目 ID。可从你的控制台中的 API keys 页面复制。

请求体

application/json

messages · object[] · 必填

提供给代理的消息列表。系统始终会自动在前面添加一条默认的系统提示，因此通常只需包含用户消息。

显示 子属性

branch · string

代理应处理的 Git branch 名称。如省略，代理会根据消息内容生成一个 branch 名称。

asDraft · boolean · 默认值: false

控制拉取请求（PR；亦称“合并请求”/Merge Request）是以草稿模式还是非草稿模式创建。为 true 时，会创建草稿拉取请求（PR；亦称“合并请求”/Merge Request）。为 false 时（默认），会创建可供评审的常规拉取请求（PR；亦称“合并请求”/Merge Request）。

model · enum<string> · 默认值: sonnet

用于代理任务的 AI 模型。使用 sonnet 可获得更快、更具成本效益的处理。使用 opus 可获得能力更强但速度较慢的处理。

可用选项: sonnet, opus

响应

200 - text/plain

代理任务创建成功（流式响应）。响应中会返回 X-Session-Id 标头

包含代理任务执行详细信息和结果的流式响应。