Get agent job (v2)

Poll for the status and details of an agent job, including the PR link once created.

GET /agent/{projectId}/job/{id}

Get agent job

cURL

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

200

{
  "id": "<string>",
  "status": "active",
  "source": {
    "repository": "<string>",
    "ref": "<string>"
  },
  "model": "<string>",
  "prLink": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "archivedAt": "2023-11-07T05:31:56Z"
}

This endpoint retrieves the current status and details of a specific agent job. Use it to poll for completion and retrieve the PR link once the agent creates one.

Job statuses

Status	Description
active	The job is currently running
completed	The job finished successfully
failed	The job encountered an error
archived	The job has been archived

Polling recommendations

• Poll every 5-10 seconds while the job is active
• Stop polling once the status is completed, failed, or archived
• The prLink field is populated once the agent creates a pull request

Response fields

Field	Description
id	Unique identifier for the job
status	Current status of the job
source.repository	GitHub repository URL
source.ref	Git branch name where changes are made
model	AI model used for the job
prLink	URL of the created pull request (null until created)
createdAt	Timestamp when the job was created
archivedAt	Timestamp when the job was archived (null if active)

Authorizations

Authorization · string · header · required

The Authorization header expects a Bearer token. Use an admin API key (prefixed with mint_). This is a server-side secret key. 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

200

application/json

Agent job details retrieved successfully.

id · string

Unique identifier for the agent job.

status · enum<string>

Current status of the agent job.

Available options: active, completed, archived, failed

source · object

Information about the source repository.

Show child attributes

model · string

The AI model used for this job.

prLink · string | null

URL of the pull request created by the agent. Null until the PR is created.

createdAt · string<date-time>

Timestamp when the job was created.

archivedAt · string<date-time> | null

Timestamp when the job was archived. Null if still active.