Skip to main content
GET
/
v1
/
agent
/
{projectId}
/
job
/
{id}
curl -X GET https://api.mintlify.com/v1/agent/your_project_id/job/session_abc123 \
  -H "Authorization: Bearer mint_your_api_key_here"

{
  "sessionId": "session_abc123",
  "subdomain": "your-docs",
  "branch": "agent-updates",
  "haulted": true,
  "haultReason": "completed",
  "pullRequestLink": "https://github.com/your-org/your-repo/pull/123",
  "messageToUser": "Successfully updated the getting started guide with installation instructions.",
  "todos": [
    {
      "content": "Update installation section",
      "status": "completed",
      "priority": "high",
      "id": "todo_1"
    },
    {
      "content": "Add code examples",
      "status": "completed",
      "priority": "medium",
      "id": "todo_2"
    }
  ],
  "createdAt": "2024-03-15T10:30:00.000Z"
}
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.

​
Authentication

Requires an admin API key (prefixed with mint_). 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

The response includes information such as:
  • Job execution status and completion state
  • Branch information and pull request details
  • Session metadata and timestamps
​
sessionId
string
The unique session identifier.
​
subdomain
string
The subdomain this session belongs to.
​
branch
string
Git branch name where changes were made.
​
haulted
boolean
Whether the session execution was halted.
​
haultReason
string
Reason for session halt. Possible values: completed, github_missconfigured, error.
​
pullRequestLink
string
Link to the created pull request.
​
messageToUser
string
Message for the user about the session outcome.
​
todos
array
List of todo items from the session.
​
createdAt
string
Timestamp when the session was created (ISO 8601 format).
curl -X GET https://api.mintlify.com/v1/agent/your_project_id/job/session_abc123 \
  -H "Authorization: Bearer mint_your_api_key_here"

{
  "sessionId": "session_abc123",
  "subdomain": "your-docs",
  "branch": "agent-updates",
  "haulted": true,
  "haultReason": "completed",
  "pullRequestLink": "https://github.com/your-org/your-repo/pull/123",
  "messageToUser": "Successfully updated the getting started guide with installation instructions.",
  "todos": [
    {
      "content": "Update installation section",
      "status": "completed",
      "priority": "high",
      "id": "todo_1"
    },
    {
      "content": "Add code examples",
      "status": "completed",
      "priority": "medium",
      "id": "todo_2"
    }
  ],
  "createdAt": "2024-03-15T10:30:00.000Z"
}

Build docs developers (and LLMs) love

Get started for freeTalk to us