> ## Documentation Index
> Fetch the complete documentation index at: https://docs.convertly.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve a job



## OpenAPI

````yaml /openapi.json get /api/jobs/{id}
openapi: 3.1.0
info:
  title: Convertly API
  version: 1.0.0
  description: >-
    Convertly provides production API endpoints for media conversion,
    compression, Image CDN delivery, Forma AI, HLS/DASH video streaming, media
    tools, async jobs, workflows, webhooks, and Convertly Storage.
  license:
    name: Proprietary
    url: https://convertly.sh/terms
servers:
  - url: https://convertly.sh
security:
  - bearerAuth: []
  - apiKeyAuth: []
paths:
  /api/jobs/{id}:
    get:
      tags:
        - Jobs
      summary: Retrieve a job
      operationId: getJob
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Job detail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobDetail'
        '401':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
components:
  schemas:
    JobDetail:
      type: object
      properties:
        jobId:
          type: string
          format: uuid
        jobType:
          type: string
          enum:
            - convert
            - compress
            - media_tool
            - transfer
        status:
          $ref: '#/components/schemas/JobStatus'
        totalFiles:
          type: integer
        completedFiles:
          type: integer
        failedFiles:
          type: integer
        progress:
          type: integer
        errorMessage:
          type:
            - string
            - 'null'
        results:
          type:
            - object
            - array
            - 'null'
        createdAt:
          type: string
          format: date-time
        completedAt:
          type:
            - string
            - 'null'
          format: date-time
      required:
        - jobId
        - jobType
        - status
        - totalFiles
        - completedFiles
        - failedFiles
        - progress
        - createdAt
    JobStatus:
      type: string
      enum:
        - pending
        - processing
        - completed
        - failed
    Error:
      type: object
      properties:
        error:
          type: string
        upgradeUrl:
          type: string
      required:
        - error
  responses:
    Error:
      description: Error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Dashboard-generated Convertly API key. Keys currently begin with
        `cvly_`.
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Alternative API key header for server-side clients.

````