CHILI GraFx Environment API: Descriptions for Brand Kit media and colors

✨ New & Improved

Describe what each media item and color is for

A name identifies a Brand Kit element, but it does not tell you when to use it. "Logo alt" and "Accent 2" mean something to the person who created them, and little to anyone else who reads the Brand Kit afterwards.

Media and color elements now take an optional description: a free-text string that explains what the element is for.

{
  "media": [
    {
      "name": "Logo",
      "mediaId": "df9c3576-f9ee-4c0e-bfdd-37e2f69da230",
      "description": "Primary logo, for light backgrounds"
    }
  ],
  "colors": [
    {
      "name": "Accent",
      "type": "cmyk",
      "description": "Accent color, reserved for calls to action"
    }
  ]
}

Two things to know:

• A description belongs to the element, not to the theme. You set it on the default theme, and every theme of the Brand Kit shares it, so "Primary logo" means the same thing on the master brand and on every sub-brand. Editing a description through a non-default theme returns 400 Bad Request.
• It is optional. Existing Brand Kits keep working unchanged, and elements without a description return none.

The Brand Kit endpoints of the Environment API accept and return descriptions. See Elements for how descriptions fit into a Brand Kit.

What's next

Descriptions give AI-driven features the context that a name alone does not carry, so that GraFx Genie can pick the right media item or color for a given design. That is not available yet.

More info

Read more in the Developer Center