cURL
curl --request POST \
--url http://localhost:3001/api/v1/brand-kit \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"slug": "<string>",
"website": "<string>",
"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>"
}
}
}
'{
"success": true,
"brandId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"message": "<string>"
}Brand-Kit
Post apiv1brand kit
POST
/
api
/
v1
/
brand-kit
cURL
curl --request POST \
--url http://localhost:3001/api/v1/brand-kit \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"slug": "<string>",
"website": "<string>",
"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>"
}
}
}
'{
"success": true,
"brandId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"message": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://segmentflow.ai/docs/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Unified API key for server-side SDK and API integrations
Body
application/json
Response
Default Response
⌘I

