创建代理作业
复制
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>"代理
创建代理作业
创建一个新的 agent 作业，可根据提供的消息和 branch 信息生成并编辑文档。
POST
/
agent
/
{projectId}
/
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 的限制如下：
为获得最佳效果，请使用 ai-sdk 的 useChat 钩子 来发送请求并处理响应。
速率限制
- 每个 Mintlify 项目每小时最多可调用 100 次
建议用法
Authorizations
Authorization 请求头需要使用 Bearer token。请在此处创建一个 Admin API Key（管理员 API 密钥）。
Body
application/json
代理应处理的 Git branch 名称，若该 branch 不存在，将会自动创建
控制是否以草稿模式或非草稿模式创建拉取请求（PR；亦称“合并请求”/Merge Request）。为 true 时，将创建草稿拉取请求；为 false 时，将创建常规（非草稿）拉取请求，供审核使用。
Response
200 - text/plain
代理任务已成功创建（流式响应）。X-Session-Id 头会随响应一同返回
包含代理任务执行详情和结果的流式响应。
⌘I