Skip to main content
GET
/
v2
/
agent
/
{projectId}
/
job
/
{id}
Get agent job
curl --request GET \
  --url https://api.mintlify.com/v2/agent/{projectId}/job/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "status": "active",
  "source": {
    "repository": "<string>",
    "ref": "<string>"
  },
  "model": "<string>",
  "prLink": "https://github.com/org/repo/pull/123",
  "createdAt": "2023-11-07T05:31:56Z",
  "archivedAt": "2023-11-07T05:31:56Z"
}
Poll this endpoint to track the progress of an agent job. The status field transitions through active → completed or failed. Once the agent creates a pull request, the prLink field is populated.

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.

Response

Agent job details

​
id
string

Unique identifier for the agent job.

​
status
enum<string>

Current status of the job. active — the agent is currently processing the prompt. completed — the agent finished successfully and a PR may have been created (check prLink). failed — the agent encountered an unrecoverable error. Poll until status is completed or failed.

Available options:
active,
completed,
failed
​
source
object

Source repository information.

​
model
string

The AI model used for this job.

​
prLink
string<uri> | null

GitHub pull request URL created by the agent. null while the job is still active or if no files were changed. Populated once the agent successfully creates a PR.

Example:

"https://github.com/org/repo/pull/123"

​
createdAt
string<date-time>

Timestamp when the job was created.

​
archivedAt
string<date-time> | null

Timestamp when the job was archived.