Skip to main content
This guide walks you through installing and configuring the platform products on a self-hosted Prisme.ai deployment — Agent Creator, LLM Gateway, Storage (vector store), Governe, Insights, Builder, Helper Agents — once the platform itself is up and running. If you are upgrading an existing instance from legacy products, follow Migration v27 instead. The installation is split into four phases:
1

First connection

Log in as super admin and create your organization.
2

Products initialization

Import the new platform workspaces in the correct order.
3

Post-install configuration

Declare LLM providers, models, vector store and organization settings.
4

Organization configuration

Allowed models, join rules, appearance, menu.
This page assumes the platform is already deployed and configured — Helm release rolled out, image tags pinned, WORKSPACE_SECRET_* credentials exposed, readiness check passing. If you are not at that point yet, follow Install with Helm then Configuration.

​
Prerequisites

Before starting product installation, make sure:
  • You can sign in as a super admin (configured under config.admins in your Helm values).
  • The Platform workspace is visible in Builder.
  • LLM provider credentials are available as platform secrets or environment variables.

​
1. First connection

1

Log in as super admin

Once all services are deployed, sign in to the platform with a super admin account — the accounts listed under config.admins in your Helm values.
2

Create your organization

From the onboarding screen, create your organization:
  • Name — the display name shown across the UI.
  • Technical name — the unique identifier used throughout the platform. It cannot be changed after creation.
3

Verify platform readiness

Open the native Govern app from the left menu and open the Infrastructure page. Verify the platform is healthy by testing Vector Stores and native Services connectivity with the Test buttons.You can also manually call the Readiness API with shell commands.
4

Open Builder

After creation, you should be redirected to a near-empty platform with two links in the left menu: Builder and Govern. Open Builder.

​
2. Products initialization

The platform products are imported in four sequential groups via the Platform workspace bulk import:

base1

Foundation apps (Custom Code, Prisme.ai API, …).

base2

Extended base (Crawler, RedisSearch, …).

extended

Legacy AI products (Knowledges, AI Store, …) — still required as a dependency for the platform products. They will disappear in a future release.

one-product

Main platform products (LLM Gateway, Storage, Governe, Agent Creator, …).
Always wait for workspaces.bulkImport.completed (with no errors) before importing the next group — each group depends on the previous one.

​
Import from the UI

1

Open the Platform workspace

The Platform workspace is only visible to super admins.
2

Trigger the bulk import

Navigate to Settings → Versions → Platform Pull, then select the Release vXXX platform repository.
3

Select the group and start the import

Pick the group, start the import, and close the modal.
4

Monitor progress

From the Activity feed of the Platform workspace, wait for the workspaces.bulkImport.completed event before moving on.
5

Repeat for the next group

Import the groups in order: base1 → base2 → extended → one-product.

​
Import from the API

You can trigger the same import through the API instead of the UI: 
curl -X POST "${API_URL}/v2/workspaces/platform/versions/latest/pull" \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{"repository": {"id": "release"}, "groups": ["base1"]}'
Repeat with base2, extended, then one-product.
Re-importing a group can overwrite workspace changes made in Builder since the previous import. Use it intentionally.

​
3. Post-install configuration

Once all groups are imported, configure each new workspace in the order below.

​
3.1 Governe — set the admin token

The Governe workspace needs an adminAccessToken to call platform APIs on behalf of administrators.
1

Generate a long-term token

From your super admin account, generate a long-term API token (Settings → Account → API tokens).
2

Paste it into the workspace

In Builder, open the Governe workspace → Settings → Secrets, paste the value into adminAccessToken, then Save.

​
3.2 LLM providers

1

Open the Govern app

From the left menu, open Govern → Models → Providers tab.
2

Declare each provider

Click Add provider and pick the provider type (OpenAI, Azure OpenAI, AWS Bedrock, …). For each provider:
  • Set the secret names to match the secrets you exposed via WORKSPACE_SECRET_llm-gateway_* environment variables (or stored in the LLM Gateway workspace Secrets).
  • Configure provider-specific options (region, endpoint, deployment name, …).
Hover the (i) icon next to a secret input to see the matching environment variable name.
3

(Optional) Configure secrets from the UI

If you’d rather store the secrets on the platform itself instead of through env vars:
  1. Open Builder in a new tab.
  2. Open the LLM Gateway workspace → Settings → Secrets.
  3. Add the secrets, using the same names as referenced by your providers.
4

Save

Save the providers configuration.
All LLM providers can be exported and re-imported from the three-dot menu — useful for replicating configuration across environments.

​
3.3 LLM models

1

Open the Models tab

Still in Govern → Models, switch to the Models tab.
2

Declare each model

Click Add model and select the provider, model identifier, capabilities (completion / embedding / vision), and any default parameters.
3

Verify with the Test button

For every model:
  • Open it and click Test — the model response is shown below the button.
  • For embedding models, the dimensions option must be set explicitly.
Models can also be exported / imported in bulk from the three-dot menu.

​
3.4 Vector store

1

Open the Infrastructure page

From the Govern menu, open Infrastructure.
2

Pick a driver

Select your vector store driver: Elasticsearch or OpenSearch.
3

Set credential secret names

Make sure the credential secret names match the values you exposed via WORKSPACE_SECRET_storage_* environment variables.
Hover the (i) icon next to a secret input to see the matching environment variable name.
To configure secrets directly from the UI instead:
  1. Open Builder in a new tab.
  2. Open the Storage workspace → Settings → Secrets.
  3. Add the secrets.
4

Set the index prefix

Set vector_store_index_prefix to the prefix you want for your RAG indexes (e.g. prod_rag).
5

Save and Test

Save the configuration, then click Test. If the test fails, review your environment variables, secrets, or database connectivity and try again.
The raw vector store configuration lives in Storage workspace settings — accessible via the Edit button at the top right of the Storage workspace.

​
3.5 Infrastructure checkup

While on the Infrastructure page, use the Test button at the bottom of the Services block to verify connectivity to all platform databases.

​
3.6 Helper agents (optional)

Helper agents assist users while they fill forms in Prisme.ai products.
1

Configure HELPER_AGENT_ENDPOINT

Set HELPER_AGENT_ENDPOINT on the relevant services.
2

Initialize

Open the Helper Agents workspace and run the initialization automations.
3

Wire credentials in Governe

Configure the generated helper credentials in Governe.
4

Test

Open a product form and confirm helpers are available.

​
4. Organization configuration

​
4.1 Allowed models

1

Open your organization

Open Organizations and select the organization you created in step 2.
2

Open Agent controls

Navigate to Agent controls.
3

Pick allowed models

Select all models you want to make available (you can use Select all). Models can be reordered by drag-and-drop.
4

Set defaults

Choose the default Completions and Embeddings models for the organization.
5

Save

Scroll to the bottom of the page and click Save.

​
4.2 Join rules

Join rules control which users automatically become members of your organization.
1

Open Join Rules

Navigate to the Join Rules page.
2

Add a rule

Add a rule with:
  • Field: Email
  • Operator: matches (wildcard)
  • Value: * to match all authenticated users
Or configure a more specific filter if you only want a subset of users to join automatically. Other users can still join with an invite code or be invited manually by an org admin.
3

Pick the assigned role

On a fresh install there is no legacy role mapping to fall back on, so set Assign role explicitly — typically org:member for the default rule, and add stricter rules above it for admins / builders.
For more advanced rules — assigning different roles or groups based on email or SSO metadata — see the Join Rules documentation.

​
4.3 Appearance

Configure your platform branding: name, favicon, colors, terms of use, …
All appearance settings can be exported / imported via the three-dot menu in the top-right corner.

​
4.4 Menu editor

A default menu template is available here.
1

Download the template

Download the JSON file from the URL above.
2

Import it

Open the Menu Editor, click the three-dot menu in the top-right corner, and import the JSON file.
3

Save and refresh

Save your changes and refresh the page — the left menu should now be populated.

​
Validation checklist

Before handing the platform to users, verify:
  • Readiness API returns ready for required services.
  • All product import groups completed without errors.
  • Governe has a valid adminAccessToken.
  • Organization join rules assign the expected roles and groups.
  • Menu entries point to the enabled products.
  • At least one completion model and one embedding model are tested and allowed.
  • Storage infrastructure test passes.
  • Agent Creator can create and run a test agent.
  • Insights access is restricted and dashboards load.
  • Custom Code and Crawler tests pass if those apps are enabled.

​
Troubleshooting

Check the Governe menu editor and organization access rules. Also confirm the product workspace was imported by the one-product group.
Confirm that the model exists in Govern > Models, the provider is saved, the model test succeeds, and the model is allowed for the user’s organization.
Check provider secret names, network egress to the model provider, provider API versions, deployment names, and rate limits.
Check WORKSPACE_SECRET_storage_* secret names, vector store host reachability, credentials, TLS settings, and index permissions.
Open the workspaces.bulkImport.completed event in the Platform workspace Activity feed. Check the errors payload, resolve missing dependencies or slug conflicts, then re-import the failed group.
Check prismeai-functions logs for dependency installation errors. If dependencies are still installing or missing, re-save the affected Custom Code app to restart installation.

​
Next steps

Migration v27

Already running an older version? Use the migration guide instead.

Model governance

Manage providers, models, defaults, and routing behavior.

Agent Creator

Create and test agents once models and storage are configured.

Operate

Updates, backups and scaling.