生成导出包

将已完成的静态导出任务打包为单个归档文件，并返回一个下载链接。该链接为预签名的 S3 URL —— 请在 expiresAt 之前下载。

任务的 status 必须为 completed 才能生成软件包。

静态导出仅适用于 Enterprise 套餐。

POST /static-export/jobs/{jobId}/bundle

生成导出软件包

cURL

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

import requests

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

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

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

print(response.text)

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

fetch('https://api.mintlify.com/v1/static-export/jobs/{jobId}/bundle', 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/jobs/{jobId}/bundle",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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/jobs/{jobId}/bundle"

	req, _ := http.NewRequest("POST", 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))

}

HttpResponse<String> response = Unirest.post("https://api.mintlify.com/v1/static-export/jobs/{jobId}/bundle")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

200

{
  "jobId": "se_3f9a2c1b8e7d4a06",
  "bundleUrl": "https://mintlify-static-exports.s3.amazonaws.com/se_3f9a2c1b8e7d4a06/bundle.tar.gz?X-Amz-Signature=...",
  "sizeBytes": 18432000,
  "expiresAt": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

静态导出需要 Enterprise 套餐。

授权

Authorization · string · header · 必填

管理员 API 密钥。可在控制台的 API 密钥页面生成。

路径参数

jobId · string · 必填

已完成的静态导出任务的 ID。

响应

200

application/json

指向静态导出软件包的预签名 S3 链接。

jobId · string · 必填

生成此软件包所对应的任务 ID。

示例:

"se_3f9a2c1b8e7d4a06"

bundleUrl · string<uri> · 必填

指向静态导出软件包归档的预签名 S3 链接。请在链接过期前下载。

示例:

"https://mintlify-static-exports.s3.amazonaws.com/se_3f9a2c1b8e7d4a06/bundle.tar.gz?X-Amz-Signature=..."

sizeBytes · integer · 必填

软件包大小（字节）。

示例:

18432000

expiresAt · string<date-time> · 必填

预签名链接的过期时间。