通过 ID 获取代理任务

根据其 ID 获取指定代理任务的详细信息和状态。

GET /agent/{projectId}/job/{id}

通过 ID 获取代理任务

cURL

curl --request GET \
  --url https://api.mintlify.com/v1/agent/{projectId}/job/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "sessionId": "<string>",
  "subdomain": "<string>",
  "branch": "<string>",
  "haulted": true,
  "haultReason": "completed",
  "pullRequestLink": "<string>",
  "messageToUser": "<string>",
  "todos": [
    {
      "content": "<string>",
      "status": "pending",
      "priority": "high",
      "id": "<string>"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z"
}

​

用法

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

​

作业详情

响应包含以下信息：

• 作业执行状态与完成情况
• 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

pullRequestLink · string

指向已创建拉取请求（PR，亦称“合并请求”/Merge Request）的链接。

messageToUser · string

用于告知用户会话结果的消息。

todos · object[]

本次会话的待办事项清单。

显示 子属性

createdAt · string<date-time>

会话创建时间的时间戳。