Iniciar job de exportación estática

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" ] } '

Autorizaciones

Authorization

string

header

requerido

Clave de API de administrador. Genera una en la página de claves de API de tu dashboard.

Cuerpo

application/json

domain

string

requerido

El dominio de la implementación que se va a exportar, por ejemplo docs.example.com.

Ejemplo:

"docs.example.com"

version

string

Una etiqueta de versión opcional para identificar esta exportación. Por defecto, se usa la última versión publicada.

Ejemplo:

"2024-06-01"

paths

string[]

Una lista opcional de rutas de página que se incluirán. Si se omite, se exportan todas las páginas publicadas.

Ejemplo:

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

Respuesta

El trabajo de exportación fue aceptado y puesto en cola.

jobId

string

requerido

Identificador único del trabajo de exportación estática.

Ejemplo:

"se_3f9a2c1b8e7d4a06"

status

enum<string>

requerido

El estado actual del trabajo.

Opciones disponibles:

queued,

running,

completed,

failed

Ejemplo:

"running"

progress

number

requerido

Porcentaje de finalización de 0 a 100.

Rango requerido: 0 <= x <= 100

Ejemplo:

42

pageCount

integer

requerido

El número de páginas exportadas hasta el momento.

Ejemplo:

128

createdAt

string<date-time>

requerido

Cuándo se creó el trabajo.

updatedAt

string<date-time>

requerido

Cuándo se actualizó por última vez el trabajo.

error

string | null

Un mensaje de error legible por humanos. Solo está presente cuando status es failed.