Get agent job

Retrieve the details and status of a specific agent job

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.

Usage

The response includes information such as:

• Job execution status and completion state
• Branch information and pull request details
• Session metadata and timestamps

cURL

curl -X GET https://api.mintlify.com/v1/agent/{projectId}/job/{id} \
  -H "Authorization: Bearer YOUR_API_KEY"

const response = await fetch(
  `https://api.mintlify.com/v1/agent/${projectId}/job/${jobId}`,
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);

const job = await response.json();
console.log('Job status:', job.haulted ? 'Completed' : 'Running');
console.log('Pull request:', job.pullRequestLink);

import requests

response = requests.get(
    f"https://api.mintlify.com/v1/agent/{project_id}/job/{job_id}",
    headers={
        "Authorization": "Bearer YOUR_API_KEY"
    }
)

job = response.json()
print(f"Job status: {'Completed' if job['haulted'] else 'Running'}")
print(f"Pull request: {job.get('pullRequestLink', 'N/A')}")

Endpoint

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

sessionId · string

The session ID for this job.

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 (completed).

haultReason · string

Reason for session halt. One of: 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.

Show todo object

content · string

Brief description of the task.

status · string

Current status of the task. One of: pending, in_progress, completed, cancelled.

priority · string

Priority level of the task. One of: high, medium, low.

id · string

Unique identifier for the todo item.

createdAt · string

ISO 8601 timestamp when the session was created.

Response

{
  "sessionId": "abc123xyz789",
  "subdomain": "example",
  "branch": "agent-update-docs",
  "haulted": true,
  "haultReason": "completed",
  "pullRequestLink": "https://github.com/your-org/your-repo/pull/123",
  "messageToUser": "Successfully updated the introduction page with new API endpoint information.",
  "todos": [
    {
      "content": "Update introduction.mdx with new API endpoint",
      "status": "completed",
      "priority": "high",
      "id": "todo-1"
    },
    {
      "content": "Create pull request",
      "status": "completed",
      "priority": "medium",
      "id": "todo-2"
    }
  ],
  "createdAt": "2024-01-15T10:30:00.000Z"
}

Authentication

This endpoint requires an admin API key (prefixed with mint_). Generate one on the API keys page in your dashboard.