Exportación estática

Iniciar job de exportación estática

Inicia un trabajo de exportación estática para una implementación. El trabajo prerrenderiza tu documentación en un conjunto autocontenido de archivos HTML, RSC y recursos estáticos. Devuelve un ID de trabajo que puedes usar para consultar el estado y, una vez completado, generar un paquete descargable.

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

Autentícate con una clave de API de administrador.

POST

static-export

jobs

Iniciar trabajo de exportación estática

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

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

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

Autorizaciones

Authorization

string

header

requerido

El encabezado Authorization requiere un token de tipo Bearer. Usa una clave de API de administrador. Esta es una clave secreta del lado del servidor. Genera una en la página de claves de API de tu dashboard.

Cuerpo

application/json

domain

string

requerido

El dominio de la implementación que se va a exportar, por ejemplo docs.example.com.

Ejemplo:

"docs.example.com"

version

string

Una etiqueta de versión opcional para identificar esta exportación. Por defecto, se usa la última versión publicada.

Ejemplo:

"2024-06-01"

paths

string[]

Una lista opcional de rutas de página que se incluirán. Si se omite, se exportan todas las páginas publicadas.

Ejemplo:

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

Respuesta

El trabajo de exportación fue aceptado y puesto en cola.

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.

Obtener estadísticas de llamadas del assistant

Obtener estado del job de exportación estática

⌘I

Iniciar trabajo de exportación estática

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

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

Referencia de la API

Administración

Agente

assistant

Analytics

Exportación estática

Iniciar job de exportación estática

Autorizaciones

Cuerpo

Respuesta