跳转到主要内容
GET
/
v1
/
agent
/
{projectId}
/
job
/
{id}
按 ID 获取代理任务(v1)
curl --request GET \
  --url https://api.mintlify.com/v1/agent/{projectId}/job/{id} \
  --header 'Authorization: Bearer <token>'
{
  "sessionId": "<string>",
  "subdomain": "<string>",
  "branch": "<string>",
  "haulted": true,
  "haultReason": "completed",
  "pullRequestLink": "<string>",
  "messageToUser": "<string>",
  "todos": [
    {
      "content": "<string>",
      "status": "pending",
      "priority": "high",
      "id": "<string>"
    }
  ],
  "userId": "<string>",
  "title": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}
此端点已废弃。请改用 v2 获取代理任务 端点。

用法

此端点通过代理任务的唯一标识符获取该任务的详细信息和状态。可用于查看先前创建的代理任务的进度、状态和结果。

作业详情

响应包含以下信息:
  • 作业执行状态与完成情况
  • branch 信息和拉取请求 (PR;亦称“合并请求”/Merge Request) 详情
  • 会话 metadata 与时间戳

授权

Authorization
string
header
必填

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

路径参数

projectId
string
必填

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

id
string
必填

要检索的代理任务的唯一标识符。

响应

200 - application/json

已成功检索代理任务详细信息

sessionId
string

此会话所属的子域。

subdomain
string

此会话所属的子域。

branch
string | null

进行更改的 Git branch 名称。

haulted
boolean

会话执行是否已中止。

haultReason
enum<string>

会话中止原因

可用选项:
completed,
github_missconfigured,
error

已创建的拉取请求(PR;亦称“合并请求”/Merge Request)链接。

messageToUser
string

向用户说明会话结果的消息。

todos
object[]

会话中的待办事项列表。

userId
string

创建此会话的用户 ID(如有)

title
string

用于概括代理任务的生成标题

createdAt
string<date-time>

会话创建时的时间戳。