Get agent job by ID

Retrieves the details and status of a specific agent job by its ID.

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

Try it

Get agent job by 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"
}

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

The Authorization header expects a Bearer token. Create an Admin API Key here.

Path Parameters

projectId · string · required

Your project ID. Can be copied from the API keys page in your dashboard.

id · string · required

The unique identifier of the agent job to retrieve.

Response

200 - application/json

Agent job details retrieved successfully

sessionId · string

The subdomain this session belongs to.

subdomain · string

The subdomain this session belongs to.

branch · string | null

Git branch name where changes were made.

haulted · boolean

Whether the session execution was halted.

haultReason · enum<string>

Reason for session halt.

Available options: completed, github_missconfigured, error

pullRequestLink · string

Link to the created pull request.

messageToUser · string

Message for the user about the session outcome.

todos · object[]

List of todo items from the session.

Show child attributes

content · string

Brief description of the task.

status · enum<string>

Current status of the task.

Available options: pending, in_progress, completed, cancelled

priority · enum<string>

Priority level of the task.

Available options: high, medium, low

id · string

Unique identifier for the todo item.

createdAt · string<date-time>

Timestamp when the session was created.