Démarrer une tâche d'exportation statique

Lance une tâche d’export statique pour un déploiement. La tâche pré-rend votre documentation sous la forme d’un ensemble autonome de fichiers HTML, RSC et ressources statiques. Retourne un identifiant de tâche que vous pouvez utiliser pour interroger le statut et, une fois la tâche terminée, générer un paquet téléchargeable.

L’export statique est disponible sur les plans Enterprise.

POST /static-export/jobs

Lancer une tâche d’export statique

cURL

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

import requests

url = "https://api.mintlify.com/v1/static-export/jobs"

payload = {
    "domain": "docs.example.com",
    "version": "2024-06-01",
    "paths": ["index", "guides/getting-started", "api-reference/introduction"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    domain: 'docs.example.com',
    version: '2024-06-01',
    paths: ['index', 'guides/getting-started', 'api-reference/introduction']
  })
};

fetch('https://api.mintlify.com/v1/static-export/jobs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mintlify.com/v1/static-export/jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'domain' => 'docs.example.com',
    'version' => '2024-06-01',
    'paths' => [
        'index',
        'guides/getting-started',
        'api-reference/introduction'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mintlify.com/v1/static-export/jobs"

	payload := strings.NewReader("{\n  \"domain\": \"docs.example.com\",\n  \"version\": \"2024-06-01\",\n  \"paths\": [\n    \"index\",\n    \"guides/getting-started\",\n    \"api-reference/introduction\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mintlify.com/v1/static-export/jobs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"domain\": \"docs.example.com\",\n  \"version\": \"2024-06-01\",\n  \"paths\": [\n    \"index\",\n    \"guides/getting-started\",\n    \"api-reference/introduction\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mintlify.com/v1/static-export/jobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domain\": \"docs.example.com\",\n  \"version\": \"2024-06-01\",\n  \"paths\": [\n    \"index\",\n    \"guides/getting-started\",\n    \"api-reference/introduction\"\n  ]\n}"

response = http.request(request)
puts response.read_body

202

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

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

L’exportation statique nécessite un forfait Enterprise.

Le champ domain est le nom d’hôte sur lequel votre documentation est servie — le domaine personnalisé configuré pour votre projet dans le tableau de bord Mintlify (par exemple, docs.example.com), ou votre sous-domaine Mintlify (par exemple, acme.mintlify.app) si vous n’avez pas configuré de domaine personnalisé. Indiquez uniquement le nom d’hôte, sans le protocole ni aucun préfixe de chemin.

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.

Corps

application/json

domain · string · requis

Le domaine principal du déploiement à exporter. Utilisez le domaine personnalisé configuré pour votre projet dans le tableau de bord Mintlify (par exemple, docs.example.com). Si vous n'avez pas configuré de domaine personnalisé, utilisez votre sous-domaine Mintlify (par exemple, acme.mintlify.app). Fournissez uniquement le nom d'hôte — n'incluez pas le protocole, ni une barre oblique finale, ni un préfixe de chemin tel que /docs.

Exemple:

"docs.example.com"

version · string

Un libellé de version facultatif pour identifier cet export. Par défaut, il s’agit de la dernière version publiée.

Exemple:

"2024-06-01"

paths · string[]

Une liste facultative de chemins de page à inclure. Si elle est omise, toutes les pages publiées sont exportées.

Exemple:

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

Réponse

202

application/json

La tâche d’export a été acceptée et mise en file d’attente.

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.