Obtenir le statut d'une tâche d'exportation statique

Récupère le statut et la progression actuels d’une tâche d’export statique. Interrogez cet endpoint après avoir lancé une tâche jusqu’à ce que status soit completed (ou failed).

L’export statique est disponible sur les plans Enterprise.

GET /static-export/jobs/{jobId}

Obtenir le statut d’une tâche d’export statique

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

L’exportation statique nécessite un forfait Enterprise.

Autorisations

Authorization · string · header · requis

Clé d’API administrateur. Générez-en une sur la page des clés d’API de votre Dashboard.

Paramètres de chemin

jobId · string · requis

L’identifiant de la tâche d’export statique retourné par Start static export job.

Réponse

200

application/json

L’état actuel de la tâche d’export.

jobId · string · requis

Identifiant unique de la tâche d’export statique.

Exemple:

"se_3f9a2c1b8e7d4a06"

status · enum<string> · requis

L’état actuel de la tâche.

Options disponibles: queued, running, completed, failed

Exemple:

"running"

progress · number · requis

Pourcentage d’avancement de 0 à 100.

Plage requise: 0 <= x <= 100

Exemple:

42

pageCount · integer · requis

Le nombre de pages exportées jusqu’à présent.

Exemple:

128

createdAt · string<date-time> · requis

Date de création de la tâche.

updatedAt · string<date-time> · requis

Date de la dernière mise à jour de la tâche.

error · string | null

Un message d’erreur lisible par un humain. Présent uniquement lorsque status est failed.