Available since: 10.4.2

The profile image editor toolbar is displayed when editing a record's profile image, and allows interaction.worker automations to generate profile images.

For instance, creating images from text/emoji, file uploads, or APIs like Stable Diffusion.

Interactions must return an image:url: or image:text: key.

Built-in interactions are provided for text-based images, file uploads, and fetching images from an external URL.

This improves on the previous built-in functionality by allowing admins to add custom logic to profile image creation – for instance, profanity and adult content filters.

Configuration

Navigate to Search » Toolbars.

Edit the record for record.profile.image.editor.

Add interactions using toolbar KATA.

interaction/stability:
  label: Stable Diffusion
  icon: picture
  uri: cerb:automation:example.interaction.recordProfileImage.stabilityai

The following placeholders are available in KATA:

Key
`image_height`	The height of the image to be generated.
`image_width`	The width of the image to be generated.
`record_*`	The record profile being viewed. Supports key expansion. The `record__type` placeholder is the type (e.g. `ticket`).
`worker_*`	The active worker record. Supports key expansion.

Interactions

Caller: cerb.toolbar.record.profile

Inputs

The following caller_params are passed to the interaction:

Key	Type
`image_height`	The height of the image to be generated.
`image_width`	The width of the image to be generated.
`record_`	record	The record dictionary

Output

An interaction should return one of:

Key	Type
`image:text:`	Text or emoji to convert into an image.
`image:url:`	An image URL to load. This can be `/ui/image/<token>` in the case of automation resources.

after:

Key	Type
`refresh_toolbar@bool:`	boolean	Refresh the current toolbar.