Static export

Get static export job status

Retrieve the current status of a static export job. Poll this endpoint after starting a job until status is completed (or failed).

Once the job completes, the response includes a bundleUrl, sizeBytes, and expiresAt. The bundleUrl is a time-limited presigned S3 link. Download the bundle before the expiresAt timestamp. Call this endpoint again to get a fresh link. The underlying export files remain reusable.

Static export is available on Enterprise plans.

Authenticate with an admin API key.

GET

static-export

{projectId}

jobs

{jobId}

Get static export job status

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

import requests

url = "https://api.mintlify.com/v1/static-export/{projectId}/jobs/{jobId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.mintlify.com/v1/static-export/{projectId}/jobs/{jobId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mintlify.com/v1/static-export/{projectId}/jobs/{jobId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mintlify.com/v1/static-export/{projectId}/jobs/{jobId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.mintlify.com/v1/static-export/{projectId}/jobs/{jobId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

This endpoint is in private beta and requires an enterprise agreement. Please contact sales@mintlify.com to inquire further.

Authorizations

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.

Path Parameters

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.

Response

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-exports.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.

Get static export job status

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

import requests

url = "https://api.mintlify.com/v1/static-export/{projectId}/jobs/{jobId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.mintlify.com/v1/static-export/{projectId}/jobs/{jobId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mintlify.com/v1/static-export/{projectId}/jobs/{jobId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mintlify.com/v1/static-export/{projectId}/jobs/{jobId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.mintlify.com/v1/static-export/{projectId}/jobs/{jobId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

API reference

Admin

Agent

Assistant

Search

Mintlify Index

Analytics

Static export

Get static export job status

Authorizations

Path Parameters

Response