启动静态导出作业

curl --request POST \ --url https://api.mintlify.com/v1/static-export/jobs \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "domain": "docs.example.com", "version": "2024-06-01", "paths": [ "index", "guides/getting-started", "api-reference/introduction" ] } '

授权

Authorization

string

header

必填

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

请求体

application/json

domain

string

必填

要导出的部署所对应的域名，例如 docs.example.com。

示例:

"docs.example.com"

version

string

用于标记此次导出的可选版本标签。默认为最新发布的版本。

示例:

"2024-06-01"

paths

string[]

要包含的页面路径的可选列表。省略时，将导出所有已发布的页面。

示例:

[
  "index",
  "guides/getting-started",
  "api-reference/introduction"
]

响应

导出任务已被接受并加入队列。

jobId

string

必填

静态导出任务的唯一标识符。

示例:

"se_3f9a2c1b8e7d4a06"

status

enum<string>

必填

任务的当前状态。

可用选项:

queued,

running,

completed,

failed

示例:

"running"

progress

number

必填

完成百分比，范围为 0 到 100。

必填范围: 0 <= x <= 100

示例:

42

pageCount

integer

必填

目前已导出的页面数量。

示例:

128

createdAt

string<date-time>

必填

任务的创建时间。

updatedAt

string<date-time>

必填

任务的最后更新时间。

error

string | null

人类可读的错误消息。仅当 status 为 failed 时才会出现。