curl --request POST \
--url https://api.parallellabs.app/api/v0/canvas/templates/preview \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"templateId": "<string>",
"companyId": "<string>",
"format": "<string>",
"width": 123,
"height": 123,
"brandKitId": "<string>",
"colorPalette": {}
}
'import requests
url = "https://api.parallellabs.app/api/v0/canvas/templates/preview"
payload = {
"templateId": "<string>",
"companyId": "<string>",
"format": "<string>",
"width": 123,
"height": 123,
"brandKitId": "<string>",
"colorPalette": {}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
templateId: '<string>',
companyId: '<string>',
format: '<string>',
width: 123,
height: 123,
brandKitId: '<string>',
colorPalette: {}
})
};
fetch('https://api.parallellabs.app/api/v0/canvas/templates/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.parallellabs.app/api/v0/canvas/templates/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([
'templateId' => '<string>',
'companyId' => '<string>',
'format' => '<string>',
'width' => 123,
'height' => 123,
'brandKitId' => '<string>',
'colorPalette' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.parallellabs.app/api/v0/canvas/templates/preview"
payload := strings.NewReader("{\n \"templateId\": \"<string>\",\n \"companyId\": \"<string>\",\n \"format\": \"<string>\",\n \"width\": 123,\n \"height\": 123,\n \"brandKitId\": \"<string>\",\n \"colorPalette\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.parallellabs.app/api/v0/canvas/templates/preview")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"templateId\": \"<string>\",\n \"companyId\": \"<string>\",\n \"format\": \"<string>\",\n \"width\": 123,\n \"height\": 123,\n \"brandKitId\": \"<string>\",\n \"colorPalette\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.parallellabs.app/api/v0/canvas/templates/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"templateId\": \"<string>\",\n \"companyId\": \"<string>\",\n \"format\": \"<string>\",\n \"width\": 123,\n \"height\": 123,\n \"brandKitId\": \"<string>\",\n \"colorPalette\": {}\n}"
response = http.request(request)
puts response.read_body{
"html": "<string>",
"width": 123,
"height": 123
}{
"error": "<string>"
}{
"error": "<string>"
}Preview a canvas template
Returns the template’s HTML filled with sample content in a brand kit’s colors and logo. Free — nothing is rendered or saved.
curl --request POST \
--url https://api.parallellabs.app/api/v0/canvas/templates/preview \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"templateId": "<string>",
"companyId": "<string>",
"format": "<string>",
"width": 123,
"height": 123,
"brandKitId": "<string>",
"colorPalette": {}
}
'import requests
url = "https://api.parallellabs.app/api/v0/canvas/templates/preview"
payload = {
"templateId": "<string>",
"companyId": "<string>",
"format": "<string>",
"width": 123,
"height": 123,
"brandKitId": "<string>",
"colorPalette": {}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
templateId: '<string>',
companyId: '<string>',
format: '<string>',
width: 123,
height: 123,
brandKitId: '<string>',
colorPalette: {}
})
};
fetch('https://api.parallellabs.app/api/v0/canvas/templates/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.parallellabs.app/api/v0/canvas/templates/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([
'templateId' => '<string>',
'companyId' => '<string>',
'format' => '<string>',
'width' => 123,
'height' => 123,
'brandKitId' => '<string>',
'colorPalette' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.parallellabs.app/api/v0/canvas/templates/preview"
payload := strings.NewReader("{\n \"templateId\": \"<string>\",\n \"companyId\": \"<string>\",\n \"format\": \"<string>\",\n \"width\": 123,\n \"height\": 123,\n \"brandKitId\": \"<string>\",\n \"colorPalette\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.parallellabs.app/api/v0/canvas/templates/preview")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"templateId\": \"<string>\",\n \"companyId\": \"<string>\",\n \"format\": \"<string>\",\n \"width\": 123,\n \"height\": 123,\n \"brandKitId\": \"<string>\",\n \"colorPalette\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.parallellabs.app/api/v0/canvas/templates/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"templateId\": \"<string>\",\n \"companyId\": \"<string>\",\n \"format\": \"<string>\",\n \"width\": 123,\n \"height\": 123,\n \"brandKitId\": \"<string>\",\n \"colorPalette\": {}\n}"
response = http.request(request)
puts response.read_body{
"html": "<string>",
"width": 123,
"height": 123
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.
Body
Template to preview
Template ID from GET /api/v0/canvas/templates
Company that owns brandKitId
Named canvas format (same values as POST /api/v0/canvas, e.g. 'square', 'portrait', 'story', 'landscape'); default 'portrait'. Ignored when width/height are given.
Custom width in px; requires height
Custom height in px; requires width
Brand kit whose colors and logo to preview with; defaults to the company's default brand kit
Unsaved palette {primary, secondary, accent, background, surface, text} as #RRGGBB; overrides the brand kit palette

