Get all agent jobs

Retrieves all agent jobs for the specified domain, including their status and details.

GET /agent/{projectId}/jobs

Try it

Get all agent jobs

cURL

curl --request GET \
  --url https://api.mintlify.com/v1/agent/{projectId}/jobs \
  --header 'Authorization: Bearer <token>'

200

{
  "allSessions": [
    {
      "sessionId": "<string>",
      "subdomain": "<string>",
      "branch": "<string>",
      "haulted": true,
      "haultReason": "completed",
      "pullRequestLink": "<string>",
      "messageToUser": "<string>",
      "todos": [
        {
          "content": "<string>",
          "status": "pending",
          "priority": "high",
          "id": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Usage

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.

Response

Use this endpoint to get a comprehensive view of all previous agent sessions.

Authorizations

Authorization · string · header · required

The Authorization header expects a Bearer token. Create an Admin API Key here.

Path Parameters

projectId · string · required

Your project ID. Can be copied from the API keys page in your dashboard.

Response

200 - application/json

All agent jobs retrieved successfully

allSessions · object[]

Array of all agent sessions for the domain.

Show child attributes

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.

Available options: completed, github_missconfigured, error

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.

Show child attributes

content · string

Brief description of the task.

status · enum<string>

Current status of the task.

Available options: pending, in_progress, completed, cancelled

priority · enum<string>

Priority level of the task.

Available options: high, medium, low

id · string

Unique identifier for the todo item.

createdAt · string<date-time>

Timestamp when the session was created.