Get static export job status

GET

/

static-export

/

/

jobs

/

Get static export job status

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

{
  "jobId": "6520f3a1c9b1a20012ab34cd",
  "status": "completed",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "error": "<string>",
  "bundleUrl": "https://mintlify-static-export-outputs-prod.s3.amazonaws.com/6520f3a1c9b1a20012ab34cd/export.zip?X-Amz-Signature=...",
  "sizeBytes": 18432000,
  "expiresAt": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorization

string

header

required

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 in your dashboard.

projectId

string

required

Your project ID. Can be copied from the API keys page in your dashboard.

jobId

string

required

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

The current state of the export job.

jobId

string

required

Unique identifier for the static export job.

Example:

"6520f3a1c9b1a20012ab34cd"

status

enum<string>

required

The current state of the job.

Available options:

queued,

running,

completed,

failed

Example:

"completed"

createdAt

string<date-time>

required

When the job was created.

updatedAt

string<date-time>

required

When the job last transitioned state.

error

string | null

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

bundleUrl

string<uri>

A time-limited presigned S3 link to the static export bundle archive. Present only when status is completed. Download the bundle before expiresAt. Call this endpoint again to get a fresh link.

Example:

"https://mintlify-static-export-outputs-prod.s3.amazonaws.com/6520f3a1c9b1a20012ab34cd/export.zip?X-Amz-Signature=..."

sizeBytes

integer

The size of the bundle in bytes. Present only when status is completed.

Example:

18432000

expiresAt

string<date-time>

When the current bundleUrl expires. Present only when status is completed.

⌘I