Skip to main content
POST
创建代理作业
此端点会根据提供的消息和 branch 信息创建一个代理任务。该任务异步执行,并以流式方式返回包含执行详情与结果的响应。 如果 branch 不存在,代理会自动创建该 branch。若文件编辑成功,任务结束时会自动创建一个拉取请求(PR;亦称“合并请求”/Merge Request)。

速率限制

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

建议用法

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

授权

Authorization
string
header
必填

Authorization 请求头需要使用 Bearer token。请在此处创建一个 Admin API Key(管理员 API 密钥)

路径参数

projectId
string
必填

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

请求体

application/json
branch
string
必填

代理应处理的 Git branch 名称,若该 branch 不存在,将会自动创建

messages
object[]
必填

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

asDraft
boolean
默认值:true

控制是否以草稿模式或非草稿模式创建拉取请求(PR;亦称“合并请求”/Merge Request)。为 true 时,将创建草稿拉取请求;为 false 时,将创建常规(非草稿)拉取请求,供审核使用。

model
enum<string>
默认值:sonnet

用于该智能体任务的 AI 模型。使用 sonnet 可获得更快捷、成本更低的处理。使用 opus 可获得更强大但速度更慢的处理。

可用选项:
sonnet,
opus

响应

200 - text/plain

代理任务已成功创建(流式响应)。X-Session-Id 头会随响应一同返回

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