cURL
curl --request PUT \
--url http://localhost:3001/api/v1/brand-kit/{brandId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"brandKit": {
"website": "<string>",
"blogUrl": "<string>",
"name": "<string>",
"companyName": "<string>",
"companyDescription": "<string>",
"tagline": "<string>",
"brandSummary": "<string>",
"industry": "<string>",
"landingPagePurpose": "<string>",
"brandMessage": "<string>",
"keyMessages": [
"<string>"
],
"languages": [
"<string>"
],
"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>"
}
}
}
'import requests
url = "http://localhost:3001/api/v1/brand-kit/{brandId}"
payload = { "brandKit": {
"website": "<string>",
"blogUrl": "<string>",
"name": "<string>",
"companyName": "<string>",
"companyDescription": "<string>",
"tagline": "<string>",
"brandSummary": "<string>",
"industry": "<string>",
"landingPagePurpose": "<string>",
"brandMessage": "<string>",
"keyMessages": ["<string>"],
"languages": ["<string>"],
"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>" }
} }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
brandKit: {
website: '<string>',
blogUrl: '<string>',
name: '<string>',
companyName: '<string>',
companyDescription: '<string>',
tagline: '<string>',
brandSummary: '<string>',
industry: '<string>',
landingPagePurpose: '<string>',
brandMessage: '<string>',
keyMessages: ['<string>'],
languages: ['<string>'],
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>'}
}
})
};
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 => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'brandKit' => [
'website' => '<string>',
'blogUrl' => '<string>',
'name' => '<string>',
'companyName' => '<string>',
'companyDescription' => '<string>',
'tagline' => '<string>',
'brandSummary' => '<string>',
'industry' => '<string>',
'landingPagePurpose' => '<string>',
'brandMessage' => '<string>',
'keyMessages' => [
'<string>'
],
'languages' => [
'<string>'
],
'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>'
]
]
]),
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 := "http://localhost:3001/api/v1/brand-kit/{brandId}"
payload := strings.NewReader("{\n \"brandKit\": {\n \"website\": \"<string>\",\n \"blogUrl\": \"<string>\",\n \"name\": \"<string>\",\n \"companyName\": \"<string>\",\n \"companyDescription\": \"<string>\",\n \"tagline\": \"<string>\",\n \"brandSummary\": \"<string>\",\n \"industry\": \"<string>\",\n \"landingPagePurpose\": \"<string>\",\n \"brandMessage\": \"<string>\",\n \"keyMessages\": [\n \"<string>\"\n ],\n \"languages\": [\n \"<string>\"\n ],\n \"colors\": [\n \"<string>\"\n ],\n \"colorsPalette\": {\n \"primary\": [\n \"<string>\"\n ],\n \"secondary\": [\n \"<string>\"\n ],\n \"accent\": [\n \"<string>\"\n ],\n \"background\": [\n \"<string>\"\n ],\n \"text\": [\n \"<string>\"\n ],\n \"border\": [\n \"<string>\"\n ],\n \"link\": [\n \"<string>\"\n ],\n \"success\": [\n \"<string>\"\n ],\n \"warning\": [\n \"<string>\"\n ],\n \"error\": [\n \"<string>\"\n ]\n },\n \"fonts\": [\n \"<string>\"\n ],\n \"typography\": {\n \"baseUnit\": 123,\n \"borderRadius\": \"<string>\",\n \"fontSizes\": {},\n \"fontWeights\": {},\n \"lineHeights\": {},\n \"fontStacks\": {},\n \"spacing\": {\n \"padding\": {},\n \"margins\": {},\n \"gridGutter\": 123\n }\n },\n \"emailFonts\": {\n \"primary\": {\n \"original\": \"<string>\",\n \"family\": \"<string>\",\n \"googleFontsUrl\": \"<string>\",\n \"fontStack\": \"<string>\",\n \"weights\": [\n 123\n ],\n \"isSystem\": true\n },\n \"heading\": {\n \"original\": \"<string>\",\n \"family\": \"<string>\",\n \"googleFontsUrl\": \"<string>\",\n \"fontStack\": \"<string>\",\n \"weights\": [\n 123\n ],\n \"isSystem\": true\n },\n \"code\": {\n \"original\": \"<string>\",\n \"family\": \"<string>\",\n \"googleFontsUrl\": \"<string>\",\n \"fontStack\": \"<string>\",\n \"weights\": [\n 123\n ],\n \"isSystem\": true\n }\n },\n \"logos\": [\n \"<string>\"\n ],\n \"images\": {\n \"logo\": \"<string>\",\n \"favicon\": \"<string>\",\n \"ogImage\": \"<string>\",\n \"additional\": [\n \"<string>\"\n ],\n \"logoS3Key\": \"<string>\",\n \"faviconS3Key\": \"<string>\",\n \"ogImageS3Key\": \"<string>\",\n \"logoSourceUrl\": \"<string>\",\n \"faviconSourceUrl\": \"<string>\",\n \"ogImageSourceUrl\": \"<string>\",\n \"socialLogos\": {},\n \"logoDimensions\": {\n \"width\": 123,\n \"height\": 123\n },\n \"logoRejection\": {\n \"measured\": {\n \"width\": 123,\n \"height\": 123\n },\n \"required\": {\n \"minWidth\": 123,\n \"minHeight\": 123,\n \"maxWidth\": 123,\n \"maxHeight\": 123,\n \"minAspectRatio\": 123,\n \"maxAspectRatio\": 123\n }\n },\n \"faviconRejection\": {\n \"measured\": {\n \"width\": 123,\n \"height\": 123\n },\n \"required\": {\n \"minWidth\": 123,\n \"minHeight\": 123,\n \"maxWidth\": 123,\n \"maxHeight\": 123,\n \"minAspectRatio\": 123,\n \"maxAspectRatio\": 123\n }\n },\n \"ogImageRejection\": {\n \"measured\": {\n \"width\": 123,\n \"height\": 123\n },\n \"required\": {\n \"minWidth\": 123,\n \"minHeight\": 123,\n \"maxWidth\": 123,\n \"maxHeight\": 123,\n \"minAspectRatio\": 123,\n \"maxAspectRatio\": 123\n }\n }\n },\n \"imageGuidelines\": {\n \"logoWidth\": 123,\n \"logoHeight\": 123,\n \"heroWidth\": 123,\n \"heroHeight\": 123,\n \"thumbnailSize\": 123,\n \"maxContentWidth\": 123\n },\n \"toneOfVoice\": \"<string>\",\n \"personality\": {\n \"tone\": \"<string>\",\n \"traits\": [\n \"<string>\"\n ]\n },\n \"authors\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"bio\": \"<string>\",\n \"role\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"avatarS3Key\": \"<string>\",\n \"email\": \"<string>\",\n \"homepage\": \"<string>\",\n \"phone\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"badges\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"imageS3Key\": \"<string>\",\n \"alt\": \"<string>\",\n \"width\": 123,\n \"height\": 123\n }\n ]\n }\n ],\n \"components\": {\n \"buttonPrimary\": {\n \"background\": \"<string>\",\n \"textColor\": \"<string>\",\n \"borderColor\": \"<string>\",\n \"focusBorderColor\": \"<string>\",\n \"borderRadius\": \"<string>\",\n \"fontWeight\": \"<string>\",\n \"padding\": \"<string>\"\n },\n \"buttonSecondary\": {\n \"background\": \"<string>\",\n \"textColor\": \"<string>\",\n \"borderColor\": \"<string>\",\n \"focusBorderColor\": \"<string>\",\n \"borderRadius\": \"<string>\",\n \"fontWeight\": \"<string>\",\n \"padding\": \"<string>\"\n },\n \"input\": {\n \"background\": \"<string>\",\n \"textColor\": \"<string>\",\n \"borderColor\": \"<string>\",\n \"focusBorderColor\": \"<string>\",\n \"borderRadius\": \"<string>\",\n \"fontWeight\": \"<string>\",\n \"padding\": \"<string>\"\n },\n \"link\": {\n \"background\": \"<string>\",\n \"textColor\": \"<string>\",\n \"borderColor\": \"<string>\",\n \"focusBorderColor\": \"<string>\",\n \"borderRadius\": \"<string>\",\n \"fontWeight\": \"<string>\",\n \"padding\": \"<string>\"\n }\n },\n \"icons\": {\n \"style\": \"<string>\",\n \"primaryColor\": \"<string>\"\n },\n \"socials\": {\n \"twitter\": \"<string>\",\n \"facebook\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"instagram\": \"<string>\",\n \"youtube\": \"<string>\",\n \"github\": \"<string>\",\n \"tiktok\": \"<string>\",\n \"pinterest\": \"<string>\",\n \"discord\": \"<string>\"\n },\n \"salutationFallback\": \"<string>\",\n \"footer\": \"<string>\",\n \"footerFeatures\": \"<string>\",\n \"disclaimers\": \"<string>\",\n \"copyright\": \"<string>\",\n \"address\": \"<string>\",\n \"phone\": \"<string>\",\n \"contactEmail\": \"<string>\",\n \"extractedAt\": \"<string>\",\n \"extractedBy\": \"<string>\",\n \"kitName\": \"<string>\",\n \"colorArray\": [\n \"<string>\"\n ],\n \"fontArray\": [\n \"<string>\"\n ],\n \"_metadata\": {\n \"lastUpdated\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("http://localhost:3001/api/v1/brand-kit/{brandId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"brandKit\": {\n \"website\": \"<string>\",\n \"blogUrl\": \"<string>\",\n \"name\": \"<string>\",\n \"companyName\": \"<string>\",\n \"companyDescription\": \"<string>\",\n \"tagline\": \"<string>\",\n \"brandSummary\": \"<string>\",\n \"industry\": \"<string>\",\n \"landingPagePurpose\": \"<string>\",\n \"brandMessage\": \"<string>\",\n \"keyMessages\": [\n \"<string>\"\n ],\n \"languages\": [\n \"<string>\"\n ],\n \"colors\": [\n \"<string>\"\n ],\n \"colorsPalette\": {\n \"primary\": [\n \"<string>\"\n ],\n \"secondary\": [\n \"<string>\"\n ],\n \"accent\": [\n \"<string>\"\n ],\n \"background\": [\n \"<string>\"\n ],\n \"text\": [\n \"<string>\"\n ],\n \"border\": [\n \"<string>\"\n ],\n \"link\": [\n \"<string>\"\n ],\n \"success\": [\n \"<string>\"\n ],\n \"warning\": [\n \"<string>\"\n ],\n \"error\": [\n \"<string>\"\n ]\n },\n \"fonts\": [\n \"<string>\"\n ],\n \"typography\": {\n \"baseUnit\": 123,\n \"borderRadius\": \"<string>\",\n \"fontSizes\": {},\n \"fontWeights\": {},\n \"lineHeights\": {},\n \"fontStacks\": {},\n \"spacing\": {\n \"padding\": {},\n \"margins\": {},\n \"gridGutter\": 123\n }\n },\n \"emailFonts\": {\n \"primary\": {\n \"original\": \"<string>\",\n \"family\": \"<string>\",\n \"googleFontsUrl\": \"<string>\",\n \"fontStack\": \"<string>\",\n \"weights\": [\n 123\n ],\n \"isSystem\": true\n },\n \"heading\": {\n \"original\": \"<string>\",\n \"family\": \"<string>\",\n \"googleFontsUrl\": \"<string>\",\n \"fontStack\": \"<string>\",\n \"weights\": [\n 123\n ],\n \"isSystem\": true\n },\n \"code\": {\n \"original\": \"<string>\",\n \"family\": \"<string>\",\n \"googleFontsUrl\": \"<string>\",\n \"fontStack\": \"<string>\",\n \"weights\": [\n 123\n ],\n \"isSystem\": true\n }\n },\n \"logos\": [\n \"<string>\"\n ],\n \"images\": {\n \"logo\": \"<string>\",\n \"favicon\": \"<string>\",\n \"ogImage\": \"<string>\",\n \"additional\": [\n \"<string>\"\n ],\n \"logoS3Key\": \"<string>\",\n \"faviconS3Key\": \"<string>\",\n \"ogImageS3Key\": \"<string>\",\n \"logoSourceUrl\": \"<string>\",\n \"faviconSourceUrl\": \"<string>\",\n \"ogImageSourceUrl\": \"<string>\",\n \"socialLogos\": {},\n \"logoDimensions\": {\n \"width\": 123,\n \"height\": 123\n },\n \"logoRejection\": {\n \"measured\": {\n \"width\": 123,\n \"height\": 123\n },\n \"required\": {\n \"minWidth\": 123,\n \"minHeight\": 123,\n \"maxWidth\": 123,\n \"maxHeight\": 123,\n \"minAspectRatio\": 123,\n \"maxAspectRatio\": 123\n }\n },\n \"faviconRejection\": {\n \"measured\": {\n \"width\": 123,\n \"height\": 123\n },\n \"required\": {\n \"minWidth\": 123,\n \"minHeight\": 123,\n \"maxWidth\": 123,\n \"maxHeight\": 123,\n \"minAspectRatio\": 123,\n \"maxAspectRatio\": 123\n }\n },\n \"ogImageRejection\": {\n \"measured\": {\n \"width\": 123,\n \"height\": 123\n },\n \"required\": {\n \"minWidth\": 123,\n \"minHeight\": 123,\n \"maxWidth\": 123,\n \"maxHeight\": 123,\n \"minAspectRatio\": 123,\n \"maxAspectRatio\": 123\n }\n }\n },\n \"imageGuidelines\": {\n \"logoWidth\": 123,\n \"logoHeight\": 123,\n \"heroWidth\": 123,\n \"heroHeight\": 123,\n \"thumbnailSize\": 123,\n \"maxContentWidth\": 123\n },\n \"toneOfVoice\": \"<string>\",\n \"personality\": {\n \"tone\": \"<string>\",\n \"traits\": [\n \"<string>\"\n ]\n },\n \"authors\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"bio\": \"<string>\",\n \"role\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"avatarS3Key\": \"<string>\",\n \"email\": \"<string>\",\n \"homepage\": \"<string>\",\n \"phone\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"badges\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"imageS3Key\": \"<string>\",\n \"alt\": \"<string>\",\n \"width\": 123,\n \"height\": 123\n }\n ]\n }\n ],\n \"components\": {\n \"buttonPrimary\": {\n \"background\": \"<string>\",\n \"textColor\": \"<string>\",\n \"borderColor\": \"<string>\",\n \"focusBorderColor\": \"<string>\",\n \"borderRadius\": \"<string>\",\n \"fontWeight\": \"<string>\",\n \"padding\": \"<string>\"\n },\n \"buttonSecondary\": {\n \"background\": \"<string>\",\n \"textColor\": \"<string>\",\n \"borderColor\": \"<string>\",\n \"focusBorderColor\": \"<string>\",\n \"borderRadius\": \"<string>\",\n \"fontWeight\": \"<string>\",\n \"padding\": \"<string>\"\n },\n \"input\": {\n \"background\": \"<string>\",\n \"textColor\": \"<string>\",\n \"borderColor\": \"<string>\",\n \"focusBorderColor\": \"<string>\",\n \"borderRadius\": \"<string>\",\n \"fontWeight\": \"<string>\",\n \"padding\": \"<string>\"\n },\n \"link\": {\n \"background\": \"<string>\",\n \"textColor\": \"<string>\",\n \"borderColor\": \"<string>\",\n \"focusBorderColor\": \"<string>\",\n \"borderRadius\": \"<string>\",\n \"fontWeight\": \"<string>\",\n \"padding\": \"<string>\"\n }\n },\n \"icons\": {\n \"style\": \"<string>\",\n \"primaryColor\": \"<string>\"\n },\n \"socials\": {\n \"twitter\": \"<string>\",\n \"facebook\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"instagram\": \"<string>\",\n \"youtube\": \"<string>\",\n \"github\": \"<string>\",\n \"tiktok\": \"<string>\",\n \"pinterest\": \"<string>\",\n \"discord\": \"<string>\"\n },\n \"salutationFallback\": \"<string>\",\n \"footer\": \"<string>\",\n \"footerFeatures\": \"<string>\",\n \"disclaimers\": \"<string>\",\n \"copyright\": \"<string>\",\n \"address\": \"<string>\",\n \"phone\": \"<string>\",\n \"contactEmail\": \"<string>\",\n \"extractedAt\": \"<string>\",\n \"extractedBy\": \"<string>\",\n \"kitName\": \"<string>\",\n \"colorArray\": [\n \"<string>\"\n ],\n \"fontArray\": [\n \"<string>\"\n ],\n \"_metadata\": {\n \"lastUpdated\": \"<string>\"\n }\n }\n}")
.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::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"brandKit\": {\n \"website\": \"<string>\",\n \"blogUrl\": \"<string>\",\n \"name\": \"<string>\",\n \"companyName\": \"<string>\",\n \"companyDescription\": \"<string>\",\n \"tagline\": \"<string>\",\n \"brandSummary\": \"<string>\",\n \"industry\": \"<string>\",\n \"landingPagePurpose\": \"<string>\",\n \"brandMessage\": \"<string>\",\n \"keyMessages\": [\n \"<string>\"\n ],\n \"languages\": [\n \"<string>\"\n ],\n \"colors\": [\n \"<string>\"\n ],\n \"colorsPalette\": {\n \"primary\": [\n \"<string>\"\n ],\n \"secondary\": [\n \"<string>\"\n ],\n \"accent\": [\n \"<string>\"\n ],\n \"background\": [\n \"<string>\"\n ],\n \"text\": [\n \"<string>\"\n ],\n \"border\": [\n \"<string>\"\n ],\n \"link\": [\n \"<string>\"\n ],\n \"success\": [\n \"<string>\"\n ],\n \"warning\": [\n \"<string>\"\n ],\n \"error\": [\n \"<string>\"\n ]\n },\n \"fonts\": [\n \"<string>\"\n ],\n \"typography\": {\n \"baseUnit\": 123,\n \"borderRadius\": \"<string>\",\n \"fontSizes\": {},\n \"fontWeights\": {},\n \"lineHeights\": {},\n \"fontStacks\": {},\n \"spacing\": {\n \"padding\": {},\n \"margins\": {},\n \"gridGutter\": 123\n }\n },\n \"emailFonts\": {\n \"primary\": {\n \"original\": \"<string>\",\n \"family\": \"<string>\",\n \"googleFontsUrl\": \"<string>\",\n \"fontStack\": \"<string>\",\n \"weights\": [\n 123\n ],\n \"isSystem\": true\n },\n \"heading\": {\n \"original\": \"<string>\",\n \"family\": \"<string>\",\n \"googleFontsUrl\": \"<string>\",\n \"fontStack\": \"<string>\",\n \"weights\": [\n 123\n ],\n \"isSystem\": true\n },\n \"code\": {\n \"original\": \"<string>\",\n \"family\": \"<string>\",\n \"googleFontsUrl\": \"<string>\",\n \"fontStack\": \"<string>\",\n \"weights\": [\n 123\n ],\n \"isSystem\": true\n }\n },\n \"logos\": [\n \"<string>\"\n ],\n \"images\": {\n \"logo\": \"<string>\",\n \"favicon\": \"<string>\",\n \"ogImage\": \"<string>\",\n \"additional\": [\n \"<string>\"\n ],\n \"logoS3Key\": \"<string>\",\n \"faviconS3Key\": \"<string>\",\n \"ogImageS3Key\": \"<string>\",\n \"logoSourceUrl\": \"<string>\",\n \"faviconSourceUrl\": \"<string>\",\n \"ogImageSourceUrl\": \"<string>\",\n \"socialLogos\": {},\n \"logoDimensions\": {\n \"width\": 123,\n \"height\": 123\n },\n \"logoRejection\": {\n \"measured\": {\n \"width\": 123,\n \"height\": 123\n },\n \"required\": {\n \"minWidth\": 123,\n \"minHeight\": 123,\n \"maxWidth\": 123,\n \"maxHeight\": 123,\n \"minAspectRatio\": 123,\n \"maxAspectRatio\": 123\n }\n },\n \"faviconRejection\": {\n \"measured\": {\n \"width\": 123,\n \"height\": 123\n },\n \"required\": {\n \"minWidth\": 123,\n \"minHeight\": 123,\n \"maxWidth\": 123,\n \"maxHeight\": 123,\n \"minAspectRatio\": 123,\n \"maxAspectRatio\": 123\n }\n },\n \"ogImageRejection\": {\n \"measured\": {\n \"width\": 123,\n \"height\": 123\n },\n \"required\": {\n \"minWidth\": 123,\n \"minHeight\": 123,\n \"maxWidth\": 123,\n \"maxHeight\": 123,\n \"minAspectRatio\": 123,\n \"maxAspectRatio\": 123\n }\n }\n },\n \"imageGuidelines\": {\n \"logoWidth\": 123,\n \"logoHeight\": 123,\n \"heroWidth\": 123,\n \"heroHeight\": 123,\n \"thumbnailSize\": 123,\n \"maxContentWidth\": 123\n },\n \"toneOfVoice\": \"<string>\",\n \"personality\": {\n \"tone\": \"<string>\",\n \"traits\": [\n \"<string>\"\n ]\n },\n \"authors\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"bio\": \"<string>\",\n \"role\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"avatarS3Key\": \"<string>\",\n \"email\": \"<string>\",\n \"homepage\": \"<string>\",\n \"phone\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"badges\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"imageS3Key\": \"<string>\",\n \"alt\": \"<string>\",\n \"width\": 123,\n \"height\": 123\n }\n ]\n }\n ],\n \"components\": {\n \"buttonPrimary\": {\n \"background\": \"<string>\",\n \"textColor\": \"<string>\",\n \"borderColor\": \"<string>\",\n \"focusBorderColor\": \"<string>\",\n \"borderRadius\": \"<string>\",\n \"fontWeight\": \"<string>\",\n \"padding\": \"<string>\"\n },\n \"buttonSecondary\": {\n \"background\": \"<string>\",\n \"textColor\": \"<string>\",\n \"borderColor\": \"<string>\",\n \"focusBorderColor\": \"<string>\",\n \"borderRadius\": \"<string>\",\n \"fontWeight\": \"<string>\",\n \"padding\": \"<string>\"\n },\n \"input\": {\n \"background\": \"<string>\",\n \"textColor\": \"<string>\",\n \"borderColor\": \"<string>\",\n \"focusBorderColor\": \"<string>\",\n \"borderRadius\": \"<string>\",\n \"fontWeight\": \"<string>\",\n \"padding\": \"<string>\"\n },\n \"link\": {\n \"background\": \"<string>\",\n \"textColor\": \"<string>\",\n \"borderColor\": \"<string>\",\n \"focusBorderColor\": \"<string>\",\n \"borderRadius\": \"<string>\",\n \"fontWeight\": \"<string>\",\n \"padding\": \"<string>\"\n }\n },\n \"icons\": {\n \"style\": \"<string>\",\n \"primaryColor\": \"<string>\"\n },\n \"socials\": {\n \"twitter\": \"<string>\",\n \"facebook\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"instagram\": \"<string>\",\n \"youtube\": \"<string>\",\n \"github\": \"<string>\",\n \"tiktok\": \"<string>\",\n \"pinterest\": \"<string>\",\n \"discord\": \"<string>\"\n },\n \"salutationFallback\": \"<string>\",\n \"footer\": \"<string>\",\n \"footerFeatures\": \"<string>\",\n \"disclaimers\": \"<string>\",\n \"copyright\": \"<string>\",\n \"address\": \"<string>\",\n \"phone\": \"<string>\",\n \"contactEmail\": \"<string>\",\n \"extractedAt\": \"<string>\",\n \"extractedBy\": \"<string>\",\n \"kitName\": \"<string>\",\n \"colorArray\": [\n \"<string>\"\n ],\n \"fontArray\": [\n \"<string>\"\n ],\n \"_metadata\": {\n \"lastUpdated\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"warnings": [
{
"type": "missing_legal_required",
"tokenIds": [
"<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
Put apiv1brand kit
PUT
/
api
/
v1
/
brand-kit
/
{brandId}
cURL
curl --request PUT \
--url http://localhost:3001/api/v1/brand-kit/{brandId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"brandKit": {
"website": "<string>",
"blogUrl": "<string>",
"name": "<string>",
"companyName": "<string>",
"companyDescription": "<string>",
"tagline": "<string>",
"brandSummary": "<string>",
"industry": "<string>",
"landingPagePurpose": "<string>",
"brandMessage": "<string>",
"keyMessages": [
"<string>"
],
"languages": [
"<string>"
],
"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>"
}
}
}
'import requests
url = "http://localhost:3001/api/v1/brand-kit/{brandId}"
payload = { "brandKit": {
"website": "<string>",
"blogUrl": "<string>",
"name": "<string>",
"companyName": "<string>",
"companyDescription": "<string>",
"tagline": "<string>",
"brandSummary": "<string>",
"industry": "<string>",
"landingPagePurpose": "<string>",
"brandMessage": "<string>",
"keyMessages": ["<string>"],
"languages": ["<string>"],
"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>" }
} }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
brandKit: {
website: '<string>',
blogUrl: '<string>',
name: '<string>',
companyName: '<string>',
companyDescription: '<string>',
tagline: '<string>',
brandSummary: '<string>',
industry: '<string>',
landingPagePurpose: '<string>',
brandMessage: '<string>',
keyMessages: ['<string>'],
languages: ['<string>'],
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>'}
}
})
};
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 => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'brandKit' => [
'website' => '<string>',
'blogUrl' => '<string>',
'name' => '<string>',
'companyName' => '<string>',
'companyDescription' => '<string>',
'tagline' => '<string>',
'brandSummary' => '<string>',
'industry' => '<string>',
'landingPagePurpose' => '<string>',
'brandMessage' => '<string>',
'keyMessages' => [
'<string>'
],
'languages' => [
'<string>'
],
'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>'
]
]
]),
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 := "http://localhost:3001/api/v1/brand-kit/{brandId}"
payload := strings.NewReader("{\n \"brandKit\": {\n \"website\": \"<string>\",\n \"blogUrl\": \"<string>\",\n \"name\": \"<string>\",\n \"companyName\": \"<string>\",\n \"companyDescription\": \"<string>\",\n \"tagline\": \"<string>\",\n \"brandSummary\": \"<string>\",\n \"industry\": \"<string>\",\n \"landingPagePurpose\": \"<string>\",\n \"brandMessage\": \"<string>\",\n \"keyMessages\": [\n \"<string>\"\n ],\n \"languages\": [\n \"<string>\"\n ],\n \"colors\": [\n \"<string>\"\n ],\n \"colorsPalette\": {\n \"primary\": [\n \"<string>\"\n ],\n \"secondary\": [\n \"<string>\"\n ],\n \"accent\": [\n \"<string>\"\n ],\n \"background\": [\n \"<string>\"\n ],\n \"text\": [\n \"<string>\"\n ],\n \"border\": [\n \"<string>\"\n ],\n \"link\": [\n \"<string>\"\n ],\n \"success\": [\n \"<string>\"\n ],\n \"warning\": [\n \"<string>\"\n ],\n \"error\": [\n \"<string>\"\n ]\n },\n \"fonts\": [\n \"<string>\"\n ],\n \"typography\": {\n \"baseUnit\": 123,\n \"borderRadius\": \"<string>\",\n \"fontSizes\": {},\n \"fontWeights\": {},\n \"lineHeights\": {},\n \"fontStacks\": {},\n \"spacing\": {\n \"padding\": {},\n \"margins\": {},\n \"gridGutter\": 123\n }\n },\n \"emailFonts\": {\n \"primary\": {\n \"original\": \"<string>\",\n \"family\": \"<string>\",\n \"googleFontsUrl\": \"<string>\",\n \"fontStack\": \"<string>\",\n \"weights\": [\n 123\n ],\n \"isSystem\": true\n },\n \"heading\": {\n \"original\": \"<string>\",\n \"family\": \"<string>\",\n \"googleFontsUrl\": \"<string>\",\n \"fontStack\": \"<string>\",\n \"weights\": [\n 123\n ],\n \"isSystem\": true\n },\n \"code\": {\n \"original\": \"<string>\",\n \"family\": \"<string>\",\n \"googleFontsUrl\": \"<string>\",\n \"fontStack\": \"<string>\",\n \"weights\": [\n 123\n ],\n \"isSystem\": true\n }\n },\n \"logos\": [\n \"<string>\"\n ],\n \"images\": {\n \"logo\": \"<string>\",\n \"favicon\": \"<string>\",\n \"ogImage\": \"<string>\",\n \"additional\": [\n \"<string>\"\n ],\n \"logoS3Key\": \"<string>\",\n \"faviconS3Key\": \"<string>\",\n \"ogImageS3Key\": \"<string>\",\n \"logoSourceUrl\": \"<string>\",\n \"faviconSourceUrl\": \"<string>\",\n \"ogImageSourceUrl\": \"<string>\",\n \"socialLogos\": {},\n \"logoDimensions\": {\n \"width\": 123,\n \"height\": 123\n },\n \"logoRejection\": {\n \"measured\": {\n \"width\": 123,\n \"height\": 123\n },\n \"required\": {\n \"minWidth\": 123,\n \"minHeight\": 123,\n \"maxWidth\": 123,\n \"maxHeight\": 123,\n \"minAspectRatio\": 123,\n \"maxAspectRatio\": 123\n }\n },\n \"faviconRejection\": {\n \"measured\": {\n \"width\": 123,\n \"height\": 123\n },\n \"required\": {\n \"minWidth\": 123,\n \"minHeight\": 123,\n \"maxWidth\": 123,\n \"maxHeight\": 123,\n \"minAspectRatio\": 123,\n \"maxAspectRatio\": 123\n }\n },\n \"ogImageRejection\": {\n \"measured\": {\n \"width\": 123,\n \"height\": 123\n },\n \"required\": {\n \"minWidth\": 123,\n \"minHeight\": 123,\n \"maxWidth\": 123,\n \"maxHeight\": 123,\n \"minAspectRatio\": 123,\n \"maxAspectRatio\": 123\n }\n }\n },\n \"imageGuidelines\": {\n \"logoWidth\": 123,\n \"logoHeight\": 123,\n \"heroWidth\": 123,\n \"heroHeight\": 123,\n \"thumbnailSize\": 123,\n \"maxContentWidth\": 123\n },\n \"toneOfVoice\": \"<string>\",\n \"personality\": {\n \"tone\": \"<string>\",\n \"traits\": [\n \"<string>\"\n ]\n },\n \"authors\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"bio\": \"<string>\",\n \"role\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"avatarS3Key\": \"<string>\",\n \"email\": \"<string>\",\n \"homepage\": \"<string>\",\n \"phone\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"badges\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"imageS3Key\": \"<string>\",\n \"alt\": \"<string>\",\n \"width\": 123,\n \"height\": 123\n }\n ]\n }\n ],\n \"components\": {\n \"buttonPrimary\": {\n \"background\": \"<string>\",\n \"textColor\": \"<string>\",\n \"borderColor\": \"<string>\",\n \"focusBorderColor\": \"<string>\",\n \"borderRadius\": \"<string>\",\n \"fontWeight\": \"<string>\",\n \"padding\": \"<string>\"\n },\n \"buttonSecondary\": {\n \"background\": \"<string>\",\n \"textColor\": \"<string>\",\n \"borderColor\": \"<string>\",\n \"focusBorderColor\": \"<string>\",\n \"borderRadius\": \"<string>\",\n \"fontWeight\": \"<string>\",\n \"padding\": \"<string>\"\n },\n \"input\": {\n \"background\": \"<string>\",\n \"textColor\": \"<string>\",\n \"borderColor\": \"<string>\",\n \"focusBorderColor\": \"<string>\",\n \"borderRadius\": \"<string>\",\n \"fontWeight\": \"<string>\",\n \"padding\": \"<string>\"\n },\n \"link\": {\n \"background\": \"<string>\",\n \"textColor\": \"<string>\",\n \"borderColor\": \"<string>\",\n \"focusBorderColor\": \"<string>\",\n \"borderRadius\": \"<string>\",\n \"fontWeight\": \"<string>\",\n \"padding\": \"<string>\"\n }\n },\n \"icons\": {\n \"style\": \"<string>\",\n \"primaryColor\": \"<string>\"\n },\n \"socials\": {\n \"twitter\": \"<string>\",\n \"facebook\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"instagram\": \"<string>\",\n \"youtube\": \"<string>\",\n \"github\": \"<string>\",\n \"tiktok\": \"<string>\",\n \"pinterest\": \"<string>\",\n \"discord\": \"<string>\"\n },\n \"salutationFallback\": \"<string>\",\n \"footer\": \"<string>\",\n \"footerFeatures\": \"<string>\",\n \"disclaimers\": \"<string>\",\n \"copyright\": \"<string>\",\n \"address\": \"<string>\",\n \"phone\": \"<string>\",\n \"contactEmail\": \"<string>\",\n \"extractedAt\": \"<string>\",\n \"extractedBy\": \"<string>\",\n \"kitName\": \"<string>\",\n \"colorArray\": [\n \"<string>\"\n ],\n \"fontArray\": [\n \"<string>\"\n ],\n \"_metadata\": {\n \"lastUpdated\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("http://localhost:3001/api/v1/brand-kit/{brandId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"brandKit\": {\n \"website\": \"<string>\",\n \"blogUrl\": \"<string>\",\n \"name\": \"<string>\",\n \"companyName\": \"<string>\",\n \"companyDescription\": \"<string>\",\n \"tagline\": \"<string>\",\n \"brandSummary\": \"<string>\",\n \"industry\": \"<string>\",\n \"landingPagePurpose\": \"<string>\",\n \"brandMessage\": \"<string>\",\n \"keyMessages\": [\n \"<string>\"\n ],\n \"languages\": [\n \"<string>\"\n ],\n \"colors\": [\n \"<string>\"\n ],\n \"colorsPalette\": {\n \"primary\": [\n \"<string>\"\n ],\n \"secondary\": [\n \"<string>\"\n ],\n \"accent\": [\n \"<string>\"\n ],\n \"background\": [\n \"<string>\"\n ],\n \"text\": [\n \"<string>\"\n ],\n \"border\": [\n \"<string>\"\n ],\n \"link\": [\n \"<string>\"\n ],\n \"success\": [\n \"<string>\"\n ],\n \"warning\": [\n \"<string>\"\n ],\n \"error\": [\n \"<string>\"\n ]\n },\n \"fonts\": [\n \"<string>\"\n ],\n \"typography\": {\n \"baseUnit\": 123,\n \"borderRadius\": \"<string>\",\n \"fontSizes\": {},\n \"fontWeights\": {},\n \"lineHeights\": {},\n \"fontStacks\": {},\n \"spacing\": {\n \"padding\": {},\n \"margins\": {},\n \"gridGutter\": 123\n }\n },\n \"emailFonts\": {\n \"primary\": {\n \"original\": \"<string>\",\n \"family\": \"<string>\",\n \"googleFontsUrl\": \"<string>\",\n \"fontStack\": \"<string>\",\n \"weights\": [\n 123\n ],\n \"isSystem\": true\n },\n \"heading\": {\n \"original\": \"<string>\",\n \"family\": \"<string>\",\n \"googleFontsUrl\": \"<string>\",\n \"fontStack\": \"<string>\",\n \"weights\": [\n 123\n ],\n \"isSystem\": true\n },\n \"code\": {\n \"original\": \"<string>\",\n \"family\": \"<string>\",\n \"googleFontsUrl\": \"<string>\",\n \"fontStack\": \"<string>\",\n \"weights\": [\n 123\n ],\n \"isSystem\": true\n }\n },\n \"logos\": [\n \"<string>\"\n ],\n \"images\": {\n \"logo\": \"<string>\",\n \"favicon\": \"<string>\",\n \"ogImage\": \"<string>\",\n \"additional\": [\n \"<string>\"\n ],\n \"logoS3Key\": \"<string>\",\n \"faviconS3Key\": \"<string>\",\n \"ogImageS3Key\": \"<string>\",\n \"logoSourceUrl\": \"<string>\",\n \"faviconSourceUrl\": \"<string>\",\n \"ogImageSourceUrl\": \"<string>\",\n \"socialLogos\": {},\n \"logoDimensions\": {\n \"width\": 123,\n \"height\": 123\n },\n \"logoRejection\": {\n \"measured\": {\n \"width\": 123,\n \"height\": 123\n },\n \"required\": {\n \"minWidth\": 123,\n \"minHeight\": 123,\n \"maxWidth\": 123,\n \"maxHeight\": 123,\n \"minAspectRatio\": 123,\n \"maxAspectRatio\": 123\n }\n },\n \"faviconRejection\": {\n \"measured\": {\n \"width\": 123,\n \"height\": 123\n },\n \"required\": {\n \"minWidth\": 123,\n \"minHeight\": 123,\n \"maxWidth\": 123,\n \"maxHeight\": 123,\n \"minAspectRatio\": 123,\n \"maxAspectRatio\": 123\n }\n },\n \"ogImageRejection\": {\n \"measured\": {\n \"width\": 123,\n \"height\": 123\n },\n \"required\": {\n \"minWidth\": 123,\n \"minHeight\": 123,\n \"maxWidth\": 123,\n \"maxHeight\": 123,\n \"minAspectRatio\": 123,\n \"maxAspectRatio\": 123\n }\n }\n },\n \"imageGuidelines\": {\n \"logoWidth\": 123,\n \"logoHeight\": 123,\n \"heroWidth\": 123,\n \"heroHeight\": 123,\n \"thumbnailSize\": 123,\n \"maxContentWidth\": 123\n },\n \"toneOfVoice\": \"<string>\",\n \"personality\": {\n \"tone\": \"<string>\",\n \"traits\": [\n \"<string>\"\n ]\n },\n \"authors\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"bio\": \"<string>\",\n \"role\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"avatarS3Key\": \"<string>\",\n \"email\": \"<string>\",\n \"homepage\": \"<string>\",\n \"phone\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"badges\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"imageS3Key\": \"<string>\",\n \"alt\": \"<string>\",\n \"width\": 123,\n \"height\": 123\n }\n ]\n }\n ],\n \"components\": {\n \"buttonPrimary\": {\n \"background\": \"<string>\",\n \"textColor\": \"<string>\",\n \"borderColor\": \"<string>\",\n \"focusBorderColor\": \"<string>\",\n \"borderRadius\": \"<string>\",\n \"fontWeight\": \"<string>\",\n \"padding\": \"<string>\"\n },\n \"buttonSecondary\": {\n \"background\": \"<string>\",\n \"textColor\": \"<string>\",\n \"borderColor\": \"<string>\",\n \"focusBorderColor\": \"<string>\",\n \"borderRadius\": \"<string>\",\n \"fontWeight\": \"<string>\",\n \"padding\": \"<string>\"\n },\n \"input\": {\n \"background\": \"<string>\",\n \"textColor\": \"<string>\",\n \"borderColor\": \"<string>\",\n \"focusBorderColor\": \"<string>\",\n \"borderRadius\": \"<string>\",\n \"fontWeight\": \"<string>\",\n \"padding\": \"<string>\"\n },\n \"link\": {\n \"background\": \"<string>\",\n \"textColor\": \"<string>\",\n \"borderColor\": \"<string>\",\n \"focusBorderColor\": \"<string>\",\n \"borderRadius\": \"<string>\",\n \"fontWeight\": \"<string>\",\n \"padding\": \"<string>\"\n }\n },\n \"icons\": {\n \"style\": \"<string>\",\n \"primaryColor\": \"<string>\"\n },\n \"socials\": {\n \"twitter\": \"<string>\",\n \"facebook\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"instagram\": \"<string>\",\n \"youtube\": \"<string>\",\n \"github\": \"<string>\",\n \"tiktok\": \"<string>\",\n \"pinterest\": \"<string>\",\n \"discord\": \"<string>\"\n },\n \"salutationFallback\": \"<string>\",\n \"footer\": \"<string>\",\n \"footerFeatures\": \"<string>\",\n \"disclaimers\": \"<string>\",\n \"copyright\": \"<string>\",\n \"address\": \"<string>\",\n \"phone\": \"<string>\",\n \"contactEmail\": \"<string>\",\n \"extractedAt\": \"<string>\",\n \"extractedBy\": \"<string>\",\n \"kitName\": \"<string>\",\n \"colorArray\": [\n \"<string>\"\n ],\n \"fontArray\": [\n \"<string>\"\n ],\n \"_metadata\": {\n \"lastUpdated\": \"<string>\"\n }\n }\n}")
.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::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"brandKit\": {\n \"website\": \"<string>\",\n \"blogUrl\": \"<string>\",\n \"name\": \"<string>\",\n \"companyName\": \"<string>\",\n \"companyDescription\": \"<string>\",\n \"tagline\": \"<string>\",\n \"brandSummary\": \"<string>\",\n \"industry\": \"<string>\",\n \"landingPagePurpose\": \"<string>\",\n \"brandMessage\": \"<string>\",\n \"keyMessages\": [\n \"<string>\"\n ],\n \"languages\": [\n \"<string>\"\n ],\n \"colors\": [\n \"<string>\"\n ],\n \"colorsPalette\": {\n \"primary\": [\n \"<string>\"\n ],\n \"secondary\": [\n \"<string>\"\n ],\n \"accent\": [\n \"<string>\"\n ],\n \"background\": [\n \"<string>\"\n ],\n \"text\": [\n \"<string>\"\n ],\n \"border\": [\n \"<string>\"\n ],\n \"link\": [\n \"<string>\"\n ],\n \"success\": [\n \"<string>\"\n ],\n \"warning\": [\n \"<string>\"\n ],\n \"error\": [\n \"<string>\"\n ]\n },\n \"fonts\": [\n \"<string>\"\n ],\n \"typography\": {\n \"baseUnit\": 123,\n \"borderRadius\": \"<string>\",\n \"fontSizes\": {},\n \"fontWeights\": {},\n \"lineHeights\": {},\n \"fontStacks\": {},\n \"spacing\": {\n \"padding\": {},\n \"margins\": {},\n \"gridGutter\": 123\n }\n },\n \"emailFonts\": {\n \"primary\": {\n \"original\": \"<string>\",\n \"family\": \"<string>\",\n \"googleFontsUrl\": \"<string>\",\n \"fontStack\": \"<string>\",\n \"weights\": [\n 123\n ],\n \"isSystem\": true\n },\n \"heading\": {\n \"original\": \"<string>\",\n \"family\": \"<string>\",\n \"googleFontsUrl\": \"<string>\",\n \"fontStack\": \"<string>\",\n \"weights\": [\n 123\n ],\n \"isSystem\": true\n },\n \"code\": {\n \"original\": \"<string>\",\n \"family\": \"<string>\",\n \"googleFontsUrl\": \"<string>\",\n \"fontStack\": \"<string>\",\n \"weights\": [\n 123\n ],\n \"isSystem\": true\n }\n },\n \"logos\": [\n \"<string>\"\n ],\n \"images\": {\n \"logo\": \"<string>\",\n \"favicon\": \"<string>\",\n \"ogImage\": \"<string>\",\n \"additional\": [\n \"<string>\"\n ],\n \"logoS3Key\": \"<string>\",\n \"faviconS3Key\": \"<string>\",\n \"ogImageS3Key\": \"<string>\",\n \"logoSourceUrl\": \"<string>\",\n \"faviconSourceUrl\": \"<string>\",\n \"ogImageSourceUrl\": \"<string>\",\n \"socialLogos\": {},\n \"logoDimensions\": {\n \"width\": 123,\n \"height\": 123\n },\n \"logoRejection\": {\n \"measured\": {\n \"width\": 123,\n \"height\": 123\n },\n \"required\": {\n \"minWidth\": 123,\n \"minHeight\": 123,\n \"maxWidth\": 123,\n \"maxHeight\": 123,\n \"minAspectRatio\": 123,\n \"maxAspectRatio\": 123\n }\n },\n \"faviconRejection\": {\n \"measured\": {\n \"width\": 123,\n \"height\": 123\n },\n \"required\": {\n \"minWidth\": 123,\n \"minHeight\": 123,\n \"maxWidth\": 123,\n \"maxHeight\": 123,\n \"minAspectRatio\": 123,\n \"maxAspectRatio\": 123\n }\n },\n \"ogImageRejection\": {\n \"measured\": {\n \"width\": 123,\n \"height\": 123\n },\n \"required\": {\n \"minWidth\": 123,\n \"minHeight\": 123,\n \"maxWidth\": 123,\n \"maxHeight\": 123,\n \"minAspectRatio\": 123,\n \"maxAspectRatio\": 123\n }\n }\n },\n \"imageGuidelines\": {\n \"logoWidth\": 123,\n \"logoHeight\": 123,\n \"heroWidth\": 123,\n \"heroHeight\": 123,\n \"thumbnailSize\": 123,\n \"maxContentWidth\": 123\n },\n \"toneOfVoice\": \"<string>\",\n \"personality\": {\n \"tone\": \"<string>\",\n \"traits\": [\n \"<string>\"\n ]\n },\n \"authors\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"bio\": \"<string>\",\n \"role\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"avatarS3Key\": \"<string>\",\n \"email\": \"<string>\",\n \"homepage\": \"<string>\",\n \"phone\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"badges\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"imageS3Key\": \"<string>\",\n \"alt\": \"<string>\",\n \"width\": 123,\n \"height\": 123\n }\n ]\n }\n ],\n \"components\": {\n \"buttonPrimary\": {\n \"background\": \"<string>\",\n \"textColor\": \"<string>\",\n \"borderColor\": \"<string>\",\n \"focusBorderColor\": \"<string>\",\n \"borderRadius\": \"<string>\",\n \"fontWeight\": \"<string>\",\n \"padding\": \"<string>\"\n },\n \"buttonSecondary\": {\n \"background\": \"<string>\",\n \"textColor\": \"<string>\",\n \"borderColor\": \"<string>\",\n \"focusBorderColor\": \"<string>\",\n \"borderRadius\": \"<string>\",\n \"fontWeight\": \"<string>\",\n \"padding\": \"<string>\"\n },\n \"input\": {\n \"background\": \"<string>\",\n \"textColor\": \"<string>\",\n \"borderColor\": \"<string>\",\n \"focusBorderColor\": \"<string>\",\n \"borderRadius\": \"<string>\",\n \"fontWeight\": \"<string>\",\n \"padding\": \"<string>\"\n },\n \"link\": {\n \"background\": \"<string>\",\n \"textColor\": \"<string>\",\n \"borderColor\": \"<string>\",\n \"focusBorderColor\": \"<string>\",\n \"borderRadius\": \"<string>\",\n \"fontWeight\": \"<string>\",\n \"padding\": \"<string>\"\n }\n },\n \"icons\": {\n \"style\": \"<string>\",\n \"primaryColor\": \"<string>\"\n },\n \"socials\": {\n \"twitter\": \"<string>\",\n \"facebook\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"instagram\": \"<string>\",\n \"youtube\": \"<string>\",\n \"github\": \"<string>\",\n \"tiktok\": \"<string>\",\n \"pinterest\": \"<string>\",\n \"discord\": \"<string>\"\n },\n \"salutationFallback\": \"<string>\",\n \"footer\": \"<string>\",\n \"footerFeatures\": \"<string>\",\n \"disclaimers\": \"<string>\",\n \"copyright\": \"<string>\",\n \"address\": \"<string>\",\n \"phone\": \"<string>\",\n \"contactEmail\": \"<string>\",\n \"extractedAt\": \"<string>\",\n \"extractedBy\": \"<string>\",\n \"kitName\": \"<string>\",\n \"colorArray\": [\n \"<string>\"\n ],\n \"fontArray\": [\n \"<string>\"\n ],\n \"_metadata\": {\n \"lastUpdated\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"warnings": [
{
"type": "missing_legal_required",
"tokenIds": [
"<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)$Body
application/json
Complete brand identity data: colors, fonts, logos, social links, UI components, legal copy, and extraction metadata
Show child attributes
Show child attributes
⌘I