Get static export job status

GET

static-export

jobs

{jobId}

curl --request GET \
  --url https://api.mintlify.com/v1/static-export/jobs/{jobId} \
  --header 'Authorization: Bearer <token>'

{
  "jobId": "se_3f9a2c1b8e7d4a06",
  "status": "running",
  "progress": 42,
  "pageCount": 128,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "error": "<string>"
}

Static export requires an Enterprise plan.

Authorizations

Authorization

string

header

required

Admin API key. Generate one on the API keys page in your dashboard.

Path Parameters

jobId

string

required

The ID of the static export job returned by Start static export job.

Response

The current state of the export job.

jobId

string

required

Unique identifier for the static export job.

Example:

"se_3f9a2c1b8e7d4a06"

status

enum<string>

required

The current state of the job.

Available options:

queued,

running,

completed,

failed

Example:

"running"

progress

number

required

Completion percentage from 0 to 100.

Required range: 0 <= x <= 100

Example:

42

pageCount

integer

required

The number of pages exported so far.

Example:

128

createdAt

string<date-time>

required

When the job was created.

updatedAt

string<date-time>

required

When the job was last updated.

error

string | null

A human-readable error message. Present only when status is failed.

Start static export job

Generate export bundle

⌘I

Get static export job status

curl --request GET \
  --url https://api.mintlify.com/v1/static-export/jobs/{jobId} \
  --header 'Authorization: Bearer <token>'

{
  "jobId": "se_3f9a2c1b8e7d4a06",
  "status": "running",
  "progress": 42,
  "pageCount": 128,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "error": "<string>"
}