Skip to main content
This endpoint retrieves all agent jobs for the specified domain, providing an overview of all agent activities and their current status. This is useful for monitoring and managing multiple concurrent or historical agent jobs.

​
Usage

Use this endpoint to get a comprehensive view of all previous agent sessions. 
curl -X GET https://api.mintlify.com/v1/agent/{projectId}/jobs \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Endpoint

​
projectId
string
required
Your project ID. Can be copied from the API keys page in your dashboard.

​
Response

​
allSessions
array
Array of all agent sessions for the domain.
{
  "allSessions": [
    {
      "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.",
      "todos": [
        {
          "content": "Update introduction.mdx",
          "status": "completed",
          "priority": "high",
          "id": "todo-1"
        }
      ],
      "createdAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "sessionId": "def456uvw012",
      "subdomain": "example",
      "branch": "agent-add-api-docs",
      "haulted": true,
      "haultReason": "completed",
      "pullRequestLink": "https://github.com/your-org/your-repo/pull/124",
      "messageToUser": "Created new API documentation pages.",
      "todos": [
        {
          "content": "Create API reference pages",
          "status": "completed",
          "priority": "high",
          "id": "todo-1"
        }
      ],
      "createdAt": "2024-01-14T14:20:00.000Z"
    }
  ]
}

​
Authentication

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

Build docs developers (and LLMs) love

Get started for freeTalk to us