cURL
curl --request GET \
--url http://localhost:3001/api/v1/brand-kit/{brandId} \
--header 'x-api-key: <api-key>'import requests
url = "http://localhost:3001/api/v1/brand-kit/{brandId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('http://localhost:3001/api/v1/brand-kit/{brandId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/v1/brand-kit/{brandId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "http://localhost:3001/api/v1/brand-kit/{brandId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3001/api/v1/brand-kit/{brandId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/brand-kit/{brandId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"brandKit": {
"website": "<string>",
"blogUrl": "<string>",
"name": "<string>",
"companyName": "<string>",
"companyDescription": "<string>",
"tagline": "<string>",
"brandSummary": "<string>",
"industry": "<string>",
"landingPagePurpose": "<string>",
"brandMessage": "<string>",
"keyMessages": [
"<string>"
],
"languages": "<unknown>",
"colors": [
"<string>"
],
"colorsPalette": {
"primary": [
"<string>"
],
"secondary": [
"<string>"
],
"accent": [
"<string>"
],
"background": [
"<string>"
],
"text": [
"<string>"
],
"border": [
"<string>"
],
"link": [
"<string>"
],
"success": [
"<string>"
],
"warning": [
"<string>"
],
"error": [
"<string>"
]
},
"fonts": [
"<string>"
],
"typography": {
"baseUnit": 123,
"borderRadius": "<string>",
"fontSizes": {},
"fontWeights": {},
"lineHeights": {},
"fontStacks": {},
"spacing": {
"padding": {},
"margins": {},
"gridGutter": 123
}
},
"emailFonts": {
"primary": {
"original": "<string>",
"family": "<string>",
"googleFontsUrl": "<string>",
"fontStack": "<string>",
"weights": [
123
],
"isSystem": true
},
"heading": {
"original": "<string>",
"family": "<string>",
"googleFontsUrl": "<string>",
"fontStack": "<string>",
"weights": [
123
],
"isSystem": true
},
"code": {
"original": "<string>",
"family": "<string>",
"googleFontsUrl": "<string>",
"fontStack": "<string>",
"weights": [
123
],
"isSystem": true
}
},
"logos": [
"<string>"
],
"images": {
"logo": "<string>",
"favicon": "<string>",
"ogImage": "<string>",
"additional": [
"<string>"
],
"logoS3Key": "<string>",
"faviconS3Key": "<string>",
"ogImageS3Key": "<string>",
"logoSourceUrl": "<string>",
"faviconSourceUrl": "<string>",
"ogImageSourceUrl": "<string>",
"socialLogos": {},
"logoDimensions": {
"width": 123,
"height": 123
},
"logoRejection": {
"measured": {
"width": 123,
"height": 123
},
"required": {
"minWidth": 123,
"minHeight": 123,
"maxWidth": 123,
"maxHeight": 123,
"minAspectRatio": 123,
"maxAspectRatio": 123
}
},
"faviconRejection": {
"measured": {
"width": 123,
"height": 123
},
"required": {
"minWidth": 123,
"minHeight": 123,
"maxWidth": 123,
"maxHeight": 123,
"minAspectRatio": 123,
"maxAspectRatio": 123
}
},
"ogImageRejection": {
"measured": {
"width": 123,
"height": 123
},
"required": {
"minWidth": 123,
"minHeight": 123,
"maxWidth": 123,
"maxHeight": 123,
"minAspectRatio": 123,
"maxAspectRatio": 123
}
}
},
"imageGuidelines": {
"logoWidth": 123,
"logoHeight": 123,
"heroWidth": 123,
"heroHeight": 123,
"thumbnailSize": 123,
"maxContentWidth": 123
},
"toneOfVoice": "<string>",
"personality": {
"tone": "<string>",
"traits": [
"<string>"
]
},
"authors": [
{
"id": "<string>",
"name": "<string>",
"bio": "<string>",
"role": "<string>",
"avatarUrl": "<string>",
"avatarS3Key": "<string>",
"email": "<string>",
"homepage": "<string>",
"phone": "<string>",
"tags": [
"<string>"
],
"badges": [
{
"id": "<string>",
"label": "<string>",
"imageUrl": "<string>",
"imageS3Key": "<string>",
"alt": "<string>",
"width": 123,
"height": 123
}
]
}
],
"components": {
"buttonPrimary": {
"background": "<string>",
"textColor": "<string>",
"borderColor": "<string>",
"focusBorderColor": "<string>",
"borderRadius": "<string>",
"fontWeight": "<string>",
"padding": "<string>"
},
"buttonSecondary": {
"background": "<string>",
"textColor": "<string>",
"borderColor": "<string>",
"focusBorderColor": "<string>",
"borderRadius": "<string>",
"fontWeight": "<string>",
"padding": "<string>"
},
"input": {
"background": "<string>",
"textColor": "<string>",
"borderColor": "<string>",
"focusBorderColor": "<string>",
"borderRadius": "<string>",
"fontWeight": "<string>",
"padding": "<string>"
},
"link": {
"background": "<string>",
"textColor": "<string>",
"borderColor": "<string>",
"focusBorderColor": "<string>",
"borderRadius": "<string>",
"fontWeight": "<string>",
"padding": "<string>"
}
},
"icons": {
"style": "<string>",
"primaryColor": "<string>"
},
"socials": {
"twitter": "<string>",
"facebook": "<string>",
"linkedin": "<string>",
"instagram": "<string>",
"youtube": "<string>",
"github": "<string>",
"tiktok": "<string>",
"pinterest": "<string>",
"discord": "<string>"
},
"salutationFallback": "<string>",
"footer": "<string>",
"footerFeatures": "<string>",
"disclaimers": "<string>",
"copyright": "<string>",
"address": "<string>",
"phone": "<string>",
"contactEmail": "<string>",
"extractedAt": "<string>",
"extractedBy": "<string>",
"kitName": "<string>",
"colorArray": [
"<string>"
],
"fontArray": [
"<string>"
],
"_metadata": {
"lastUpdated": "<string>"
}
},
"brandMeta": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"slug": "<string>",
"isPrimary": true
},
"message": "<string>"
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}Brand-Kit
Get apiv1brand kit 1
GET
/
api
/
v1
/
brand-kit
/
{brandId}
cURL
curl --request GET \
--url http://localhost:3001/api/v1/brand-kit/{brandId} \
--header 'x-api-key: <api-key>'import requests
url = "http://localhost:3001/api/v1/brand-kit/{brandId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('http://localhost:3001/api/v1/brand-kit/{brandId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/v1/brand-kit/{brandId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "http://localhost:3001/api/v1/brand-kit/{brandId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3001/api/v1/brand-kit/{brandId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/brand-kit/{brandId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"brandKit": {
"website": "<string>",
"blogUrl": "<string>",
"name": "<string>",
"companyName": "<string>",
"companyDescription": "<string>",
"tagline": "<string>",
"brandSummary": "<string>",
"industry": "<string>",
"landingPagePurpose": "<string>",
"brandMessage": "<string>",
"keyMessages": [
"<string>"
],
"languages": "<unknown>",
"colors": [
"<string>"
],
"colorsPalette": {
"primary": [
"<string>"
],
"secondary": [
"<string>"
],
"accent": [
"<string>"
],
"background": [
"<string>"
],
"text": [
"<string>"
],
"border": [
"<string>"
],
"link": [
"<string>"
],
"success": [
"<string>"
],
"warning": [
"<string>"
],
"error": [
"<string>"
]
},
"fonts": [
"<string>"
],
"typography": {
"baseUnit": 123,
"borderRadius": "<string>",
"fontSizes": {},
"fontWeights": {},
"lineHeights": {},
"fontStacks": {},
"spacing": {
"padding": {},
"margins": {},
"gridGutter": 123
}
},
"emailFonts": {
"primary": {
"original": "<string>",
"family": "<string>",
"googleFontsUrl": "<string>",
"fontStack": "<string>",
"weights": [
123
],
"isSystem": true
},
"heading": {
"original": "<string>",
"family": "<string>",
"googleFontsUrl": "<string>",
"fontStack": "<string>",
"weights": [
123
],
"isSystem": true
},
"code": {
"original": "<string>",
"family": "<string>",
"googleFontsUrl": "<string>",
"fontStack": "<string>",
"weights": [
123
],
"isSystem": true
}
},
"logos": [
"<string>"
],
"images": {
"logo": "<string>",
"favicon": "<string>",
"ogImage": "<string>",
"additional": [
"<string>"
],
"logoS3Key": "<string>",
"faviconS3Key": "<string>",
"ogImageS3Key": "<string>",
"logoSourceUrl": "<string>",
"faviconSourceUrl": "<string>",
"ogImageSourceUrl": "<string>",
"socialLogos": {},
"logoDimensions": {
"width": 123,
"height": 123
},
"logoRejection": {
"measured": {
"width": 123,
"height": 123
},
"required": {
"minWidth": 123,
"minHeight": 123,
"maxWidth": 123,
"maxHeight": 123,
"minAspectRatio": 123,
"maxAspectRatio": 123
}
},
"faviconRejection": {
"measured": {
"width": 123,
"height": 123
},
"required": {
"minWidth": 123,
"minHeight": 123,
"maxWidth": 123,
"maxHeight": 123,
"minAspectRatio": 123,
"maxAspectRatio": 123
}
},
"ogImageRejection": {
"measured": {
"width": 123,
"height": 123
},
"required": {
"minWidth": 123,
"minHeight": 123,
"maxWidth": 123,
"maxHeight": 123,
"minAspectRatio": 123,
"maxAspectRatio": 123
}
}
},
"imageGuidelines": {
"logoWidth": 123,
"logoHeight": 123,
"heroWidth": 123,
"heroHeight": 123,
"thumbnailSize": 123,
"maxContentWidth": 123
},
"toneOfVoice": "<string>",
"personality": {
"tone": "<string>",
"traits": [
"<string>"
]
},
"authors": [
{
"id": "<string>",
"name": "<string>",
"bio": "<string>",
"role": "<string>",
"avatarUrl": "<string>",
"avatarS3Key": "<string>",
"email": "<string>",
"homepage": "<string>",
"phone": "<string>",
"tags": [
"<string>"
],
"badges": [
{
"id": "<string>",
"label": "<string>",
"imageUrl": "<string>",
"imageS3Key": "<string>",
"alt": "<string>",
"width": 123,
"height": 123
}
]
}
],
"components": {
"buttonPrimary": {
"background": "<string>",
"textColor": "<string>",
"borderColor": "<string>",
"focusBorderColor": "<string>",
"borderRadius": "<string>",
"fontWeight": "<string>",
"padding": "<string>"
},
"buttonSecondary": {
"background": "<string>",
"textColor": "<string>",
"borderColor": "<string>",
"focusBorderColor": "<string>",
"borderRadius": "<string>",
"fontWeight": "<string>",
"padding": "<string>"
},
"input": {
"background": "<string>",
"textColor": "<string>",
"borderColor": "<string>",
"focusBorderColor": "<string>",
"borderRadius": "<string>",
"fontWeight": "<string>",
"padding": "<string>"
},
"link": {
"background": "<string>",
"textColor": "<string>",
"borderColor": "<string>",
"focusBorderColor": "<string>",
"borderRadius": "<string>",
"fontWeight": "<string>",
"padding": "<string>"
}
},
"icons": {
"style": "<string>",
"primaryColor": "<string>"
},
"socials": {
"twitter": "<string>",
"facebook": "<string>",
"linkedin": "<string>",
"instagram": "<string>",
"youtube": "<string>",
"github": "<string>",
"tiktok": "<string>",
"pinterest": "<string>",
"discord": "<string>"
},
"salutationFallback": "<string>",
"footer": "<string>",
"footerFeatures": "<string>",
"disclaimers": "<string>",
"copyright": "<string>",
"address": "<string>",
"phone": "<string>",
"contactEmail": "<string>",
"extractedAt": "<string>",
"extractedBy": "<string>",
"kitName": "<string>",
"colorArray": [
"<string>"
],
"fontArray": [
"<string>"
],
"_metadata": {
"lastUpdated": "<string>"
}
},
"brandMeta": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"slug": "<string>",
"isPrimary": true
},
"message": "<string>"
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}Authorizations
Unified API key for server-side SDK and API integrations
Path Parameters
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$⌘I

