Skip to main content
Before initializing Prisme.ai AI Products, you need to ensure that your environment meets all necessary prerequisites and configurations. This guide will walk you through the required services, configuration steps, and verification processes.

​
Requirements

​
Services running

A fully operational Prisme.ai environment is required, including both open-source and private microservices.
The following microservices must be running:
  • prismeai-api-gateway
  • prismeai-console
  • prismeai-pages
  • prismeai-workspaces
  • prismeai-events
  • prismeai-runtime

​
Offline environments

If the installation environment does not have access to internet, ensure that the following prerequisites are always met :
  • If using app microservices, prismeai-functions need access to a NPM registry. If the default https://registry.npmjs.org/ is not available, you must configure your own npm registry using NPM_CONFIG_REGISTRY environment variable inside prismeai-functions microservice
    • Depending on your NPM proxy, it might require additional configuration for authentication
  • If using internal / self-signed TLS certificates, they must be configured inside almost all microservices to avoid HTTPS errors
    • prismeai-searchengine and prismeai-crawler are Python microservices : once mounted, the certificate file location can be configured with REQUESTS_CA_BUNDLE prismeai-llm does not need the custom certificate
    • Every other prismeai-* services are NodeJS : once mounted, the certificate file location can be configured with NODE_EXTRA_CA_CERTS

​
Platform Readiness

Before proceeding with the AI Products installation, verify that the platform is healthy using the Readiness API. All core services must report a ready status: 
curl -H "Authorization: Bearer YOUR_TOKEN" https://api.your-domain.com/v2/readiness
You can directly open this url from a browser already authenticated as super admin. The response should return "status": "ready" for all services. If any service reports errors, resolve them before continuing with the installation.

​
Hardware

Minimum Requirements

  • 8 CPU cores
  • 16GB RAM
  • 100GB storage
  • Suitable for testing and small-scale deployments

Recommended Requirements

  • 16+ CPU cores
  • 64GB+ RAM
  • 250GB+ storage
  • Suitable for production deployments
Hardware requirements may vary depending on your specific usage patterns, the number of concurrent users, and the amount of data processed.

​
Storage

We recommend using:
  • MongoDB: For applications collections
  • Vector Database: one of Opensearch (recomended) or Redis Stack (with JSON and SEARCH modules)
Ensure these databases are properly configured and accessible to the prismeai-functions microservice.
prismeai-functions and prismeai-llm microservices require a RWX volume with at least 50GB and attached to a Kubernetes PVC.

​
Configuration Requirements

Several environment variables must be configured in the prismeai-runtime microservice to ensure proper functioning of installed Apps. If your deployment uses custom API ports modified by a container orchestrator or configuration, you’ll need to adapt these values accordingly.

​
Environment Variables

Environment variables in prismeai-runtime :
APP_CONFIG_CustomCode_apiUrl='http://FUNCTIONS_HOST:80'
Where FUNCTIONS_HOST refers to the domain from which the prismeai-runtime microservice can reach prismeai-functions.
Environment variables in prismeai-runtime :
COLLECTIONS_STORAGE_DRIVER=mongodb
COLLECTIONS_STORAGE_HOST=mongodb://MONGO_HOST/collections
Corresponding helm values in prismeai-runtime :
prismeai-runtime:
  storage:
    collections:
      driver: 'postgresql' # Collections db driver REQUIRED: mongodb, postgresql
      url: '' # Collections db URI REQUIRED, example: mongodb+srv://prisme:password@mongodbcluster.example/collections?authSource=admin. Note the /collections path
      existingSecret: "core-prismeai-runtime-collections" # Auto generated secret : core-prismeai-runtime-collections
      secretKeys:
        url: ''
Where MONGO_HOST should be replaced with the host that allows the prismeai-runtime microservice to connect to MongoDB (e.g., mongo if prismeai-runtime and mongo are launched from the same docker-compose).
Environment variables in prismeai-runtime :
APP_CONFIG_Crawler_apiUrl='http://SEARCHENGINE_HOST:80'
Where SEARCHENGINE_HOST is the domain from which prismeai-runtime can reach prismeai-searchengine.
Environment variables in prismeai-runtime :
APP_CONFIG_NLU_apiUrl='http://NLU_HOST:80'
Where NLU_HOST is the domain from which prismeai-runtime can reach prismeai-nlu.
The NLU App is not required for the operation of AI Products, but provides advanced intent recognition capabilities if needed.
Environment variables in prismeai-runtime :
APP_CONFIG_SendMail_apiKey='a mailgun API key'
APP_CONFIG_SendMail_region='https://api.eu.mailgun.net/'
APP_CONFIG_SendMail_domain='the mailgun domain'
The SendMail App is currently compatible only with MailGun. It remains optional and is not required for the proper functioning of the AI products.

​
AI Products Initialization Process

Once you’ve confirmed that all prerequisites have been met, you can proceed with importing the Prisme.ai App Store and associated product workspaces. The initialization process uses the Platform workspace bulk import to import workspace groups in the correct sequence, verifying functionality after each step.
The bulk import is performed from the Platform workspace, which is only accessible to super admins. Ensure you have super admin access before proceeding.

​
Importing Workspace Groups

Each group is imported using the Platform workspace’s bulk import feature. For each group:
  1. Open the Platform workspace
  2. Navigate to Versioning > Pull a version
  3. Select the “Release vXXX” platform repository
  4. Select the group to import and start the import
  5. Monitor the progress from the Activity feed of the Platform workspace
  6. Wait for the workspaces.bulkImport.completed event to appear
  7. Verify the event contains no errors before proceeding to the next group
You can also trigger the import via the API: 
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"]}'
Always wait for the workspaces.bulkImport.completed event (with no errors) before importing the next group. Each group depends on the previous one being fully imported.
Each group can be re-imported to reset all Apps/workspaces it contains, overwriting any modifications made in the studio since the first import.

​
Group base1: Base Apps

This group contains foundational apps required by many other components.

​
Key Components

Custom Code

Enables execution of custom JS/Python codeRequires the functions microservice to be online and configured

Prisme.ai API

Enables API calls to Prisme.ai from Automations (YAML files)

​
Verification Tests

After importing the first group, run these tests to verify functionality :
  1. Create a test workspace
  2. Install the Custom Code App in your test workspace
  3. Create a new function named hello with the following code:
import fetch from 'node-fetch';
const res = await fetch('https://httpbin.org/headers')
return await res.json();
  1. Test the function using the green play button
  2. Verify that the node-fetch package has been properly installed and that you receive the expected website response without any import or internal errors

​
Group base2: Extended Base

This group contains extended base applications that build upon the first group.

​
Key Components

Crawler

Web page indexing & search engineRequires the crawler and searchengine microservices

NLU

NLU engineRequires the nlu microservice

RedisSearch

Interface with the redis-stack-server database, only used by Redis RAG database

​
Verification Tests

After importing the second group, run this test to verify crawler functionality :
  1. Open the Crawler/Crawl page automation and run it with the top-right corner play button
  2. Open the Activity tab and regularly reload it until you see Crawler.notifications event has been fired
    • If this never occurs, check prismeai-crawler container logs (apps namespace) to resolve issues
  3. Open the Crawler/Search page automation and run it
  4. Verify that you receive the freshly indexed page result

​
Group extended: AI Products

This final group contains the main Prisme.ai AI products and is larger than the previous groups.
Since this group is larger, the import may take several minutes. Monitor progress from the Platform workspace Activity feed and wait for the workspaces.bulkImport.completed event.
Several new workspaces should appear when you refresh the page after the import completes.

​
Post-Import Configuration

After successfully importing all three groups, you need to proceed with the configuration of each AI Product to complete the setup process. It is advised to configure the products in the following minimum order :
  • Configure AI Governance
    • 1st, Generate a long-term token
    • Configure the adminAccessToken setting
    • Configure the Ops Manager and upgrade the core helm deployment
  • Configure super admins
    • The AI Governance shortcut has appeared, elect a PlatformAdmin and PlatformManager
  • Configure LLM providers
    • In the AI Builder > AI Knowledge > Settings section
  • Create an AI SecureChat agent
    • Finally, add this agent as a left-menu shortcut in the AI Governance > Products and Workspaces > Shortcuts section

​
Troubleshooting

If you encounter issues during the initialization process, here are some common problems and their solutions:
Several critical AI products and Apps (including AI Knowledge) are built on Custom Code. If issues arise:
  1. Monitor the logs of the prismeai-functions service
  2. Look for these error messages:
    • Failed npm install
    • Dependencies are still being installed from
    • Some dependencies are missing
    • TimeoutError
    • Failed running function
  3. If a dependency is missing or still being installed after several minutes, re-save the Custom Code App for the affected workspace from the studio. This will prompt prismeai-functions to restart the installation (Installing N modules...).
  4. If the issue concerns functions of an App (indicated by the app. prefix in the logs), you’ll need to re-publish the App.
If the bulk import reports errors in the workspaces.bulkImport.completed event:
  1. Check the errors field in the event payload for details on which workspaces failed
  2. Individual workspace import errors can also be checked in the workspaces.imported event emitted in each workspace’s activity feed
  3. Common causes include slug conflicts (a workspace with the same slug already exists) or missing dependencies (a required group was not imported first)
  4. Resolve the errors and re-import the group — workspaces already up to date will be skipped automatically.
If needed, you can force reimport all workspaces (including the ones theoritacally up to date) using the bulk import API.
If tests fail due to connectivity issues:
  1. Run the Readiness API to identify which services or dependencies are failing
  2. Ensure all required microservices are running
  3. Verify that the environment variables are correctly set
  4. Look at the logs of all services

​
Next Steps

Create your SecureChat

Create your AI Secure Chat

AI Store

Learn how to manage and deploy agents in the Store

AI Knowledge

Organize collections and document-based agents

Create an agent

Learn more about agent creation