Obtener estado del job de exportación estática

Recupera el estado y el progreso actuales de un trabajo de exportación estática. Consulta este endpoint después de iniciar un trabajo hasta que status sea completed (o failed).

La exportación estática está disponible en los planes Enterprise.

GET /static-export/jobs/{jobId}

Obtener el estado del trabajo de exportación estática

cURL

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

200

{
  "jobId": "se_3f9a2c1b8e7d4a06",
  "status": "running",
  "progress": 42,
  "pageCount": 128,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "error": "<string>"
}

La exportación estática requiere un plan Enterprise.

Autorizaciones

Authorization · string · header · requerido

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

Parámetros de ruta

jobId · string · requerido

El ID del trabajo de exportación estática devuelto por Start static export job.

Respuesta

200

application/json

El estado actual del trabajo de exportación.

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.