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

# Start static export job

> Start a static export job for a deployment. The job pre-renders your documentation into a self-contained set of static HTML, RSC, and asset files. Returns a job ID you can use to poll status and, once complete, generate a downloadable bundle.

Static export is available on Enterprise plans.

<Info>
  Static export requires an [Enterprise plan](https://mintlify.com/pricing?ref=static-export).
</Info>


## OpenAPI

````yaml static-export-openapi.json POST /static-export/jobs
openapi: 3.0.1
info:
  title: Mintlify Static Export API
  description: >-
    Programmatically generate a self-contained static export of your
    documentation and download it as a single bundle. Available on Enterprise
    plans.
  version: 1.0.0
servers:
  - url: https://api.mintlify.com/v1
security:
  - bearerAuth: []
paths:
  /static-export/jobs:
    post:
      summary: Start static export job
      description: >-
        Start a static export job for a deployment. The job pre-renders your
        documentation into a self-contained set of static HTML, RSC, and asset
        files. Returns a job ID you can use to poll status and, once complete,
        generate a downloadable bundle.


        Static export is available on Enterprise plans.
      operationId: startStaticExportJob
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartStaticExportRequest'
      responses:
        '202':
          description: The export job was accepted and queued.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StaticExportJob'
        '400':
          description: >-
            The request body is invalid. Check that `domain` is a reachable
            hostname and that `paths` entries are valid page paths.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Authentication failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            Static export is not enabled for this organization. Contact sales to
            enable it on an Enterprise plan.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    StartStaticExportRequest:
      type: object
      required:
        - domain
      properties:
        domain:
          type: string
          description: >-
            The domain of the deployment to export, for example
            `docs.example.com`.
          example: docs.example.com
        version:
          type: string
          description: >-
            An optional version label to tag this export. Defaults to the latest
            published version.
          example: '2024-06-01'
        paths:
          type: array
          description: >-
            An optional list of page paths to include. When omitted, every
            published page is exported.
          items:
            type: string
          example:
            - index
            - guides/getting-started
            - api-reference/introduction
    StaticExportJob:
      type: object
      required:
        - jobId
        - status
        - progress
        - pageCount
        - createdAt
        - updatedAt
      properties:
        jobId:
          type: string
          description: Unique identifier for the static export job.
          example: se_3f9a2c1b8e7d4a06
        status:
          type: string
          description: The current state of the job.
          enum:
            - queued
            - running
            - completed
            - failed
          example: running
        progress:
          type: number
          description: Completion percentage from 0 to 100.
          minimum: 0
          maximum: 100
          example: 42
        pageCount:
          type: integer
          description: The number of pages exported so far.
          example: 128
        createdAt:
          type: string
          format: date-time
          description: When the job was created.
        updatedAt:
          type: string
          format: date-time
          description: When the job was last updated.
        error:
          type: string
          description: >-
            A human-readable error message. Present only when `status` is
            `failed`.
          nullable: true
    Error:
      type: object
      properties:
        error:
          type: string
          description: A human-readable description of the error.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Admin API key. Generate one on the API keys page in your dashboard.

````

## Related topics

- [Static export](/docs/api/static-export/overview.md)
- [Get static export job status](/docs/api/static-export/get-job-status.md)
- [Generate export bundle](/docs/api/static-export/generate-bundle.md)