Skip to main content
GET
/
agent
/
{projectId}
/
job
/
{id}
Get agent job by ID
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>"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z"
}

​
Usage

This endpoint retrieves the details and status of a specific agent job by its unique identifier. Use this to check the progress, status, and results of a previously created agent job.

​
Job details

The response includes information such as:
  • Job execution status and completion state
  • Branch information and pull request details
  • Session metadata and timestamps

Authorizations

​
Authorization
string
header
required

Path Parameters

​
projectId
string
required
​
id
string
required

Response

200 - application/json
​
sessionId
string
​
subdomain
string
​
branch
string | null
​
haulted
boolean
​
haultReason
enum<string>
Available options:
completed,
github_missconfigured,
error
​
pullRequestLink
string
​
messageToUser
string
​
todos
object[]
​
createdAt
string<date-time>