Render Preview
curl --request POST \
--url https://api.example.com/api/public/v1/instructions/render-preview \
--header 'Content-Type: application/json' \
--data '
{
"format": "<string>",
"content": {},
"pageId": "<string>",
"revisionNumber": 123
}
'import requests
url = "https://api.example.com/api/public/v1/instructions/render-preview"
payload = {
"format": "<string>",
"content": {},
"pageId": "<string>",
"revisionNumber": 123
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({format: '<string>', content: {}, pageId: '<string>', revisionNumber: 123})
};
fetch('https://api.example.com/api/public/v1/instructions/render-preview', 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.example.com/api/public/v1/instructions/render-preview",
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([
'format' => '<string>',
'content' => [
],
'pageId' => '<string>',
'revisionNumber' => 123
]),
CURLOPT_HTTPHEADER => [
"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.example.com/api/public/v1/instructions/render-preview"
payload := strings.NewReader("{\n \"format\": \"<string>\",\n \"content\": {},\n \"pageId\": \"<string>\",\n \"revisionNumber\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/api/public/v1/instructions/render-preview")
.header("Content-Type", "application/json")
.body("{\n \"format\": \"<string>\",\n \"content\": {},\n \"pageId\": \"<string>\",\n \"revisionNumber\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/public/v1/instructions/render-preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"format\": \"<string>\",\n \"content\": {},\n \"pageId\": \"<string>\",\n \"revisionNumber\": 123\n}"
response = http.request(request)
puts response.read_body{
"format": "<string>",
"output": "<string>",
"lossReport": {}
}Instructions
Render Preview
Render a saved page or ad-hoc content to HTML or Markdown with a loss report.
POST
/
api
/
public
/
v1
/
instructions
/
render-preview
Render Preview
curl --request POST \
--url https://api.example.com/api/public/v1/instructions/render-preview \
--header 'Content-Type: application/json' \
--data '
{
"format": "<string>",
"content": {},
"pageId": "<string>",
"revisionNumber": 123
}
'import requests
url = "https://api.example.com/api/public/v1/instructions/render-preview"
payload = {
"format": "<string>",
"content": {},
"pageId": "<string>",
"revisionNumber": 123
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({format: '<string>', content: {}, pageId: '<string>', revisionNumber: 123})
};
fetch('https://api.example.com/api/public/v1/instructions/render-preview', 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.example.com/api/public/v1/instructions/render-preview",
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([
'format' => '<string>',
'content' => [
],
'pageId' => '<string>',
'revisionNumber' => 123
]),
CURLOPT_HTTPHEADER => [
"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.example.com/api/public/v1/instructions/render-preview"
payload := strings.NewReader("{\n \"format\": \"<string>\",\n \"content\": {},\n \"pageId\": \"<string>\",\n \"revisionNumber\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/api/public/v1/instructions/render-preview")
.header("Content-Type", "application/json")
.body("{\n \"format\": \"<string>\",\n \"content\": {},\n \"pageId\": \"<string>\",\n \"revisionNumber\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/public/v1/instructions/render-preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"format\": \"<string>\",\n \"content\": {},\n \"pageId\": \"<string>\",\n \"revisionNumber\": 123\n}"
response = http.request(request)
puts response.read_body{
"format": "<string>",
"output": "<string>",
"lossReport": {}
}Renders either a saved page (optionally at a historical revision) or an ad-hoc canonical document you send inline — to
html or markdown. Markdown output always carries the machine-readable loss report.
Requirements: instructions:read.
Request
Provide exactly one ofcontent or pageId.
string
required
html or markdown.object
A canonical document envelope to render without saving.
string
A saved page to render.
number
Historical page revision (only with
pageId).Response
string
Echo of the requested format.
string
The rendered document.
object | null
{lossless, format, items} — each item {nodeId, nodeType, reason, severity: "INFO" | "DATA_LOSS"}.⌘I