Skip to main content
POST
创建代理任务(v1)
此端点已废弃。请改用 v2 创建代理任务 端点。
此端点会根据提供的消息和分支信息创建一个代理任务。该任务异步执行,并以流式方式返回包含执行详情与结果的响应。 如果分支不存在,代理会自动创建该分支。若代理成功编辑了文件,任务结束时会自动创建一个拉取请求。

速率限制

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

建议用法

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

Authorizations

Authorization
string
header
required

Authorization 请求头需要使用 Bearer 令牌。请使用管理员 API 密钥。这是仅供服务端使用的机密密钥。你可以在控制台的 API 密钥页面 中生成一个。

Path Parameters

projectId
string
required

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

Body

application/json
messages
object[]
required

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

branch
string

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

asDraft
boolean
default:false

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

model
enum<string>
default:sonnet

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

Available options:
sonnet,
opus

Response

200 - text/event-stream

代理任务创建成功。返回 Server-Sent Events 流式响应。

包含代理任务执行详情和结果的 Server-Sent Events 流。