# Start static export job (/api/static-export/start-job)

<!-- agent-signals: reading_time_min: 2 · est_tokens: 1337 · updated: 2026-07-30 -->
Related: [Get static export job status](/api/static-export/get-job-status.md), [Generate export bundle](/api/static-export/generate-bundle.md), [Get unique visitors](/api/analytics/visitors.md)

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

`POST /static-export/jobs`

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.

Authenticate with an admin API key.

## OpenAPI

```json
{
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "domain"
          ],
          "properties": {
            "domain": {
              "type": "string",
              "description": "The primary domain of the deployment to export. Use the custom domain configured for your project in the Mintlify dashboard (for example, `docs.example.com`). If you haven't configured a custom domain, use your Mintlify subdomain (for example, `acme.mintlify.app`). Provide the hostname only. Do not include the protocol, a trailing slash, or a path prefix such as `/docs`.",
              "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"
              ]
            }
          }
        }
      }
    }
  },
  "responses": {
    "202": {
      "description": "The export job was accepted and queued.",
      "content": {
        "application/json": {
          "schema": {
            "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
              }
            }
          }
        }
      }
    },
    "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": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "description": "A human-readable description of the error."
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Authentication failed.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "description": "A human-readable description of the error."
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "Static export is not enabled for this organization. Contact sales to enable it on an Enterprise plan.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "description": "A human-readable description of the error."
              }
            }
          }
        }
      }
    }
  }
}
```
