Customizing PhariaAssistant

You can customize PhariaAssistant in a number of ways to suit your specific needs. This article describes the available customization options.

You now make customizations to PhariaAssistant with a PATCH request to the config/customization endpoint. This method of customization replaces the previous method of setting Helm chart values during installation, which is now deprecated.

The only exception to this is specifying the default route for PhariaAssistant, which can be configured with the value defaultRoute. See the PhariaAI Helm chart for more details.

Existing customizations done with Helm chart values will be applied once during migration, but subsequent modifications to Helm chart values will not be taken into account. All future customizations must be made through the API endpoint.


API endpoint for customizations

To customize a parameter in PhariaAssistant, you call the following endpoint:

PATCH /config/customization

The request body must contain a JSON object with the customization parameters you want to update. Only include the fields you want to modify — all fields are optional.

Customization options

Visual customization

Colors

You can customize the color scheme of the application. Omit keys as needed; only include those you want to customize.

{
  "colors": {
    "brand-bg-brand": "#your-brand-bg-brand-color",
    "core-bg-accent": "#your-core-bg-accent-color",
    "core-bg-secondary": "#your-core-bg-secondary-color",
    "core-content-secondary": "#your-core-content-secondary-color",
    "brand-content-brand": "#your-brand-content-brand-color",
    "core-content-accent": "#your-core-content-accent-color",
    "core-bg-primary": "#your-core-bg-primary-color",
    "core-bg-tertiary": "#your-core-bg-tertiary-color"
  }
}

Fonts

You can configure custom fonts and font sizes for the application. The currently supported font families are Roboto and Raleway.

{
  "fonts": {
    "family": "Your Font Family",
    "size": "16px"
  }
}

Support and contact information

Support email address

You can provide a support email address for accessibility related user inquiries:

{
  "support_email": "support@yourcompany.com"
}

Support phone number

You can provide a support phone number for accessibility related user inquiries:

{
  "support_phone": "+1-234-567-8900"
}

You can provide a link to your custom documentation:

{
  "documentation_link": "https://docs.yourcompany.com"
}

Help centre

You can configure help centre visibility and a link:

{
  "help_center_link": "https://help.yourcompany.com",
  "help_center_enabled": true
}

You can set a link to your legal imprint page:

{
  "imprint_link": "https://yourcompany.com/imprint"
}

Feature configuration

Default applications

You can configure which of your custom applications appear as built-in apps in the "Apps built by Aleph Alpha" section instead of under "Apps built by {Company Name}" on the Apps page. Provide a list of application names that are to be categorized as default applications:

{
  "default_applications": ["App Name 1", "App Name 2", "Custom Assistant"]
}

Create your own feature

You can enable or disable the "Create Your Own" feature:

{
  "create_your_own_enabled": true
}

App categories

You can customize the short label (displayed in the sidebar), long label and description (both displayed in the main screen) for both the Aleph Alpha apps and custom apps sections. Labels can be configured for multiple languages.

{
  "app_categories": {
    "localizations": [
      {
        "locale": "de",
        "built_in": {
          "label_long": "Von Aleph Alpha entwickelte Apps",
          "label_short": "Integrierte Apps",
          "description": "Dies sind integrierte Apps, die von PhariaAssistant bereitgestellt werden, um Sie schnell in den häufigsten Arbeitsabläufen zu unterstützen."
        },
        "custom": {
          "label_long": "Von YourCompany entwickelte Apps",
          "label_short": "Benutzerdefinierte Apps",
          "description": "Dies sind benutzerdefinierte Apps, die von Ihrer Organisation entwickelt wurden, um die Funktionen von PhariaAssistant zu erweitern."
        }
      },
      {
        "locale": "en",
        "built_in": {
          "label_long": "Apps built by Aleph Alpha",
          "label_short": "Built-in apps",
          "description": "These are built-in apps provided by PhariaAssistant."
        },
        "custom": {
          "label_long": "Apps built by YourCompany",
          "label_short": "Custom apps",
          "description": "These are custom apps developed by your organization to extend the capabilities of PhariaAssistant."
        }
      }
    ]
  }
}

Example: Complete customization request

The following is an example of a complete customization request containing all fields with dummy values:

{
  "colors": {
    "brand-bg-brand": "#your-brand-bg-brand-color",
    "core-bg-accent": "#your-core-bg-accent-color",
    "core-bg-secondary": "#your-core-bg-secondary-color",
    "core-content-secondary": "#your-core-content-secondary-color",
    "brand-content-brand": "#your-brand-content-brand-color",
    "core-content-accent": "#your-core-content-accent-color",
    "core-bg-primary": "#your-core-bg-primary-color",
    "core-bg-tertiary": "#your-core-bg-tertiary-color"
  },
  "fonts": {
    "family": "Roboto",
    "size": "16px"
  },
  "support_email": "support@yourcompany.com",
  "support_phone": "+1-234-567-8900",
  "documentation_link": "https://docs.yourcompany.com",
  "help_center_link": "https://help.yourcompany.com",
  "help_center_enabled": true,
  "imprint_link": "https://yourcompany.com/imprint",
  "default_applications": ["App Name 1", "App Name 2", "Custom Assistant"],
  "create_your_own_enabled": true,
  "app_categories": {
    "localizations": [
      {
        "locale": "de",
        "built_in": {
          "label_long": "Von Aleph Alpha entwickelte Apps",
          "label_short": "Integrierte Apps",
          "description": "Dies sind integrierte Apps, die von PhariaAssistant bereitgestellt werden, um Sie schnell in den häufigsten Arbeitsabläufen zu unterstützen."
        },
        "custom": {
          "label_long": "Von YourCompany entwickelte Apps",
          "label_short": "Benutzerdefinierte Apps",
          "description": "Dies sind benutzerdefinierte Apps, die von Ihrer Organisation entwickelt wurden, um die Funktionen von PhariaAssistant zu erweitern."
        }
      },
      {
        "locale": "en",
        "built_in": {
          "label_long": "Apps built by Aleph Alpha",
          "label_short": "Built-in apps",
          "description": "These are built-in apps provided by PhariaAssistant."
        },
        "custom": {
          "label_long": "Apps built by YourCompany",
          "label_short": "Custom apps",
          "description": "These are custom apps developed by your organization to extend the capabilities of PhariaAssistant."
        }
      }
    ]
  }
}