Skip to main content
GET
/
v1
/
agent
/
{projectId}
/
job
/
{id}
Get agent job by 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,
  "pullRequestLink": "<string>",
  "messageToUser": "<string>",
  "todos": [
    {
      "content": "<string>",
      "id": "<string>"
    }
  ],
  "userId": "<string>",
  "title": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://www.mintlify.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint is deprecated. Use the v2 get agent job endpoint instead.

​
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. Use an admin API key (prefixed with mint_). This is a server-side secret key. Generate one on the API keys page in your dashboard.

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. processing indicates the job is still running. interrupted indicates the job was manually interrupted.

Available options:
completed,
github_missconfigured,
error,
processing,
interrupted
​
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.

​
userId
string

The ID of the user who created this session, if available.

​
title
string

A generated title summarizing the agent job.

​
createdAt
string<date-time>

Timestamp when the session was created.

Related topics

Mintlify REST API introductionskill.mdFeedback