Getting started

Install the app

  1. Activate developer mode if you need technical menus later; ordinary setup does not require it.

  2. Go to Apps, remove the Apps filter if needed, search for AI.

  3. Install AI (Experimental) (module technical name ai).

After install, the AI root menu appears for users in the AI: User group.

Assign access rights

  1. Open Settings ‣ Users & Companies ‣ Users.

  2. For each person who may use the assistant, enable AI: User under the AI category.

  3. For administrators who configure providers, policies and agents, enable AI: Administrator.

  4. System settings (API keys, global defaults, guided setup) still require Settings / Administration rights.

Tip

Supervisors of autonomous agents must be AI: User (so they can open write proposals). They do not need AI Administrator unless they also configure the platform.

Connect a provider

  1. Open AI ‣ Configuration ‣ Providers ‣ LLM Providers.

  2. Create or open a provider and set:

    • Provider type — OpenRouter, OpenAI, Anthropic, xAI or Google Gemini.

    • API key — write-only; stored in system parameters, never shown again in clear text.

    • Optional Base URL override for compatible gateways.

    • Timeouts / retries / call deadline as needed for your workers.

  3. Use the provider’s Refresh models (or equivalent) action to import the model catalogue and prices where available.

  4. Open AI ‣ Configuration ‣ Settings and set AI Model to the model the interactive assistant should use.

Important

The assistant is a tool-calling loop. Choose a model with tool / function support enabled on the Models form (supports_tools).

Safe defaults after install

Out of the box the platform is intentionally cautious:

Area

Default

Capabilities ask, read, navigate, setup (admins only)

Enabled for AI users

write, delete, web, mcp, customize, action

Disabled

Access policy defaults

read allow; create / write / delete deny

Chat write mode

hybrid (auto-create; confirm update / delete / file attach)

Default agent

Jarvis (chat persona, no linked user)

Support Assistant agent

Present but inactive until you link a user and open channel audiences

First conversation

  1. Ensure your user has AI: User and a main model is set.

  2. Click the AI bubble in the systray (backend), or open AI ‣ Conversations and start a chat.

  3. Ask something that needs this database, for example: “Which modules are installed?” or “Search partners named Acme”.

  4. The assistant should call tools (get_environment, search, …) rather than inventing schema.

If nothing answers, check: provider active, API key set, main model set, user not banned, rate limits not exhausted (Monitoring).

Optional next steps