> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify-mintlify-d7deecde.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get agent job

> Retrieves the current status and details of an agent job. Poll this endpoint to track job progress.

Authenticate with an admin API key.

Poll this endpoint to track the progress of an agent job. The `status` field transitions through `active` → `completed` or `failed`.

After the agent creates a pull request, the `prLink` field contains the link.


## OpenAPI

````yaml admin-openapi.json GET /v2/agent/{projectId}/job/{id}
openapi: 3.0.1
info:
  title: Mintlify Admin API
  description: >-
    An API for administrative operations including documentation updates and
    agent management.
  version: 2.0.0
servers:
  - url: https://api.mintlify.com
security:
  - bearerAuth: []
paths:
  /v2/agent/{projectId}/job/{id}:
    get:
      summary: Get agent job
      description: >-
        Retrieves the current status and details of an agent job. Poll this
        endpoint to track job progress.


        Authenticate with an admin API key.
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: >-
            Your project ID. Can be copied from the [API
            keys](https://app.mintlify.com/settings/organization/api-keys) page
            in your dashboard.
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The unique identifier of the agent job.
      responses:
        '200':
          description: Agent job details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentJob'
        '404':
          description: Job not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    AgentJob:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the agent job.
        status:
          type: string
          enum:
            - active
            - completed
            - archived
            - failed
          description: >-
            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`). `archived` — the
            job has been archived. `failed` — the agent encountered an
            unrecoverable error. Poll until status is `completed`, `archived`,
            or `failed`.
        source:
          type: object
          description: Source repository information.
          properties:
            repository:
              type: string
              description: Full URL of the GitHub repository.
            ref:
              type: string
              description: Git branch the agent is working on.
              nullable: true
        model:
          type: string
          description: The AI model used for this job.
        prLink:
          type: string
          format: uri
          example: https://github.com/org/repo/pull/123
          description: >-
            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.
          nullable: true
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the job was created.
        archivedAt:
          type: string
          format: date-time
          description: Timestamp when the job was archived.
          nullable: true
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        The Authorization header expects a Bearer token. Use an admin API key.
        This is a server-side secret key. Generate one on the [API keys
        page](https://app.mintlify.com/settings/organization/api-keys) in your
        dashboard.

````