Get all agent jobs

Retrieve all agent jobs for the specified domain

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

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.

Show session object

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

{
  "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.