Export statique

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, puis empaquette le résultat dans une seule archive téléchargeable.

Un déploiement ne peut avoir qu’une seule tâche d’export statique active à la fois. Lancer une tâche alors qu’une autre est queued ou running retourne 409. L’endpoint est limité à 10 démarrages de tâche par organisation et par heure.

L’export statique est disponible sur les plans Enterprise.

Authentifiez-vous avec une clé d’API administrateur.

POST

static-export

{projectId}

jobs

Lancer une tâche d’export statique

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

import requests

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

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.mintlify.com/v1/static-export/{projectId}/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/{projectId}/jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "jobId": "6520f3a1c9b1a20012ab34cd",
  "status": "completed",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "error": "<string>",
  "bundleUrl": "https://mintlify-static-exports.s3.amazonaws.com/6520f3a1c9b1a20012ab34cd/export.zip?X-Amz-Signature=...",
  "sizeBytes": 18432000,
  "expiresAt": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Ce point de terminaison est en bêta privée et nécessite un accord entreprise. Contactez sales@mintlify.com pour en savoir plus.

Autorisations

Authorization

string

header

requis

L'en-tête Authorization requiert un jeton Bearer. Utilisez une clé d'API administrateur. Il s'agit d'une clé secrète côté serveur. Générez-en une depuis la page des clés d'API de votre Dashboard.

Paramètres de chemin

projectId

string

requis

L’identifiant de votre projet. Peut être copié depuis la page des clés d'API de votre Dashboard.

Réponse

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:

"6520f3a1c9b1a20012ab34cd"

status

enum<string>

requis

L’état actuel de la tâche.

Options disponibles:

queued,

running,

completed,

failed

Exemple:

"completed"

createdAt

string<date-time>

requis

Date de création de la tâche.

updatedAt

string<date-time>

requis

Date du dernier changement d’état de la tâche.

error

string | null

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

bundleUrl

string<uri>

Un lien S3 présigné limité dans le temps vers l’archive du paquet d’export statique. Présent uniquement lorsque status est completed. Téléchargez le paquet avant expiresAt. Rappelez cet endpoint pour obtenir un nouveau lien.

Exemple:

"https://mintlify-static-exports.s3.amazonaws.com/6520f3a1c9b1a20012ab34cd/export.zip?X-Amz-Signature=..."

sizeBytes

integer

La taille du paquet en octets. Présent uniquement lorsque status est completed.

Exemple:

18432000

expiresAt

string<date-time>

Date d’expiration de la bundleUrl actuelle. Présent uniquement lorsque status est completed.

Lancer une tâche d’export statique

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

import requests

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

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.mintlify.com/v1/static-export/{projectId}/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/{projectId}/jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "jobId": "6520f3a1c9b1a20012ab34cd",
  "status": "completed",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "error": "<string>",
  "bundleUrl": "https://mintlify-static-exports.s3.amazonaws.com/6520f3a1c9b1a20012ab34cd/export.zip?X-Amz-Signature=...",
  "sizeBytes": 18432000,
  "expiresAt": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Référence de l’API

Administration

Agent

Assistant

Recherche

Mintlify Index

Analytics

Export statique

Démarrer une tâche d'exportation statique

Autorisations

Paramètres de chemin

Réponse