Set Brand

This endpoint allows Enterprise administrators to configure and set brand identity settings for a specific user or workspace, including brand colors, fonts, logo.

Endpoint

POST enterprise/set-brand

Authentication

Include your Enterprise API credentials in the request headers:

sivi-api-key: YOUR_ENTERPRISE_API_KEY

Enterprise Admin Access Required

This endpoint can only be accessed using an Enterprise Admin API key. Regular API keys do not have sufficient privileges.

Request Body Example

{
  "abstractUserId": "281743-2322-34i44sd3-dkfjgdkjf292",
  "brandName": "Sivi",
  "brandDescription": "AI design generator for brands and layered vector based design generation",
  "brandUrl": "https://sivi.ai",
  "brandLogo": "https://sivi.ai/sivi-logo.png",
  "brandColors": ["#5662EC", "#EF9AB2"],
  "brandFonts": [],
  "brandPersona": {
    "emotions": ["happy"],
    "industry": "games",
    "audience": ["working mom", "working dad"],
    "designTags": ["minimal", "time management", "productivity", "health"],
  }
}

Request Parameters

Parameter	Type	Required	Description
abstractUserId	String	Yes	Unique identifier for the user
brandName	String	Yes	Name of the brand
brandDescription	String	Yes	Description or tagline of the brand
brandUrl	String	No	Website URL of the brand
brandLogo	String	No	URL to the brand's logo image
brandColors	Array	No	List of brand colors in hex format
brandFonts	Array	No	List of brand fonts (Coming Soon)
brandPersona	Object	No	Brand persona details
brandPersona.emotions	Array	No	List of brand emotions
brandPersona.industry	String	No	Brand industry
brandPersona.audience	Array	No	List of brand target audience
brandPersona.designTags	Array	No	List of brand design tags

Note:: See all available options for each parameter in the Brand Persona Details section.

Response

Success Response (200 OK)

{
  "status": 200,
  "body": {
    "message": "Successfully set the brand details"
  }
}

Error Responses

User Not Found (400 Bad Request)

{
  "status": 400,
  "body": {
    "message": "User does not exist"
  }
}

Authentication Error (401 Unauthorized)

{
  "status": 401,
  "body": {
    "message": "Failed to authenticate request. Please add sivi-api-key header in request"
  }
}

Invalid Input (422 Unprocessable Entity)

{
  "status": 422,
  "body": {
    "message": "Invalid input"
  }
}

Server Error (500 Internal Server Error)

{
  "status": 500,
  "body": {
    "message": "Server internal error"
  }
}

Usage Notes

• This API configures brand identity settings that will be applied to designs created in the specified user's workspace
• Brand colors should be provided as hex values (e.g., "#5662EC")
• Brand logo should be a direct URL to an image file
• For best results retrieve brand details automatically using the Extract Brand API from website to setting them manually
• After setting brand details, all new designs created by the user will incorporate these brand elements automatically
• This API is restricted to Enterprise plan customers with administrative access
• For best results, provide at least the brand name, brand description, logo, and primary colors