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, y luego empaqueta el resultado como un único archivo descargable.

Una implementación solo puede tener un trabajo de exportación estática activo a la vez. Iniciar un trabajo mientras otro está queued o running devuelve 409. El endpoint está limitado a 10 inicios de trabajo por organización por hora.

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

Autentícate con una clave de API de administrador.

POST

static-export

{projectId}

jobs

Iniciar trabajo de exportación estática

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

Este endpoint está en beta privada y requiere un acuerdo empresarial. Contacta con sales@mintlify.com para más información.

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.

Parámetros de ruta

projectId

string

requerido

El ID de tu proyecto. Puedes copiarlo desde la página de claves de API de tu dashboard.

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:

"6520f3a1c9b1a20012ab34cd"

status

enum<string>

requerido

El estado actual del trabajo.

Opciones disponibles:

queued,

running,

completed,

failed

Ejemplo:

"completed"

createdAt

string<date-time>

requerido

Cuándo se creó el trabajo.

updatedAt

string<date-time>

requerido

Cuándo el trabajo cambió de estado por última vez.

error

string | null

Un mensaje de error legible por humanos. Solo está presente cuando status es failed; de lo contrario, es null.

bundleUrl

string<uri>

Un enlace de S3 prefirmado con tiempo limitado al archivo del paquete de exportación estática. Solo está presente cuando status es completed. Descarga el paquete antes de expiresAt. Vuelve a llamar a este endpoint para obtener un enlace nuevo.

Ejemplo:

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

sizeBytes

integer

El tamaño del paquete en bytes. Solo está presente cuando status es completed.

Ejemplo:

18432000

expiresAt

string<date-time>

Cuándo caduca el bundleUrl actual. Solo está presente cuando status es completed.

Iniciar trabajo de exportación estática

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

Referencia de la API

Administración

Agente

Assistant

Búsqueda

Mintlify Index

Analytics

Exportación estática

Iniciar job de exportación estática

Autorizaciones

Parámetros de ruta

Respuesta