settings

Settings will allow users to pass the preferences for the design generation request. Based on the mode of settings sivi will take the preferences and generate the design.

mode

Mode parameter helps to choose preferences for the design. In auto mode sivi will take the preferences and generate the design. In brand mode sivi will take the brand persona preferences and generate the design. In custom mode sivi will take the custom preferences and generate the design.

ID	Display Name
auto	Auto
brand	Brand
custom	Custom

note

Only in mode custom, sivi will take preferences from the settings. Others modes will take preferences from the brand or auto based on the mode.

currentbId

currentbId parameter helps to identify the brand's preferences. It is required only in mode brand.

colors

Preferred color hex codes. It is required only in mode custom.

fontGroups

Preferred font groups for typography. It is required only in mode custom. Must contain exactly 3 font entries, one for each type: heading, subHeading, and body.

Field	Type	Required	Description
id	String	Yes	Font ID from the get-fonts endpoint
name	String	Yes	Display name of the font
type	String	Yes	Font usage type. Must be one of: heading, subHeading, body
status	String	Yes	Status of the font. Allowed values: enabled, disabled
addedBy	String	Yes	Source of the font. Allowed values: system, user

"fontGroups": [
  {
    "id": "cr9HpZiN7XA",
    "name": "FiraSans Condensed Black",
    "type": "heading",
    "status": "enabled",
    "addedBy": "system"
  },
  {
    "id": "crOvkYkeiiE",
    "name": "Raleway Bold",
    "type": "subHeading",
    "status": "enabled",
    "addedBy": "system"
  },
  {
    "id": "cJqSe7mFuRu",
    "name": "Raleway Light",
    "type": "body",
    "status": "enabled",
    "addedBy": "system"
  }
]

note

All three font types (heading, subHeading, body) are mandatory. Maximum of 3 font entries allowed.

theme

Preferred theme. It is required only in mode custom.

ID	Display Name
light	Light
dark	Dark
colorful	Colorful

frameStyle

Preferred frame style. It is required only in mode custom.

ID	Display Name
plain	Plain
box	Box
bar-accent	Bar Accent

backdropStyle

Preferred backdrop style. It is required only in mode custom.

ID	Display Name
minimalist	Minimalist
imagery	Imagery
artistic	Artistic

focus

Preferred focus. It is required only in mode custom.

ID	Display Name
text	Text
image	Image
neutral	Neutral

imageStyle

Preferred image style. It is required only in mode custom.

ID	Display Name
cover	Cover
cover-with-linear-gradient	Cover With Linear Gradient
cover-with-overlay	Cover With Overlay
container	Container
section	Section
section-with-container	Section with Container
mask	Mask
cutout	Cutout
cutout-with-vectors	Cutout with vectors
content-free-form	Content Free Form

Example Usage

Here's a comprehensive example showing how to use the brand persona parameters:

{
    "mode": "custom",
    "colors": ["#5662EC", "#EF9AB2"],
    "theme": ["light"],
    "frameStyle": ["plain"],
    "backdropStyle": ["minimalist"],
    "focus": ["text"],
    "imageStyle": ["cover"]
}

Usage Notes

• When using the API, you should specify at least mode.
• Pass colors, theme, frameStyle, backdropStyle, focus, imageStyle only in mode custom.