Générer le bundle d'exportation

POST

static-export

jobs

{jobId}

bundle

Générer le paquet d’export

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

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

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 d’une tâche d’export statique terminée.

Réponse

Un lien S3 présigné vers le paquet d’export statique.

jobId

string

requis

L’identifiant de la tâche pour laquelle ce paquet a été généré.

Exemple:

"se_3f9a2c1b8e7d4a06"

bundleUrl

string<uri>

requis

Un lien S3 présigné vers l’archive du paquet d’export statique. Téléchargez-le avant l’expiration du lien.

Exemple:

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

sizeBytes

integer

requis

La taille du paquet en octets.

Exemple:

18432000

expiresAt

string<date-time>

requis

Date d’expiration du lien présigné.

Sujets connexes

Exportation statique Démarrer une tâche d'exportation statique Exportation hors ligne

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

⌘I

Générer le paquet d’export

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

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