Workspaces

A workspace is the foundation of your AI Builder projects. It provides a complete environment for building, configuring, and deploying your AI applications.

What is a Workspace?

A workspace is a project that:

Enables various Automations inside your organization, connecting your APIs and systems
Is easily configurable through workspace config, Apps, and automation graphs
Produces events recording activities and optionally triggering automations
Presents computed data through Web Pages accessible to admins or external users
Has configurable roles providing distinct user groups with fine-grained permissions

Workspaces serve as isolated environments where you can create, test, and deploy complete AI-powered solutions.

Workspace Configuration

The workspace config provides centralized settings and parameters for your entire workspace.

Workspace configuration is defined in the workspace source code:

name: MyConfiguredWorkspace
slug: test
config:
  value:
    API_URL: https://api.mycompany.com
    LOGIN_URL: "{{config.API_URL}}/login"
    headers:
      apiKey: someAPIKey

The config.value field is exposed as a config variable inside your automations, making these settings accessible throughout your workspace.

You can reference other config values within your configuration using the {{config.PROPERTY}} syntax, as shown in the LOGIN_URL example above.

For sensitive configuration values, use secrets:

config:
  value:
    API_URL: https://api.mycompany.com
    headers:
      apiKey: "{{secret.apiKey}}"

Secrets provide a secure way to store and use sensitive information like API keys, passwords, and tokens without exposing them in your code.

Secrets with names starting with prismeai_* are reserved for super admins to configure system settings by workspace.

You can also inject configuration values from environment variables:

WORKSPACE_CONFIG_test_API_URL=https://api.mycompany.com

This environment variable would set config.API_URL for a workspace with the slug “test”. Workspace config takes precedence over environment variables.

For more controlled configuration, especially for Apps, you can define a schema for your config:

config:
  schema:
    type: object
    properties:
      API_URL:
        type: string
        title: API URL
        description: Base URL for the API
      maxRetries:
        type: number
        title: Maximum Retries
        default: 3
  value:
    API_URL: https://api.mycompany.com
    maxRetries: 5

This schema defines the structure, types, and defaults for your configuration, providing better validation and documentation.

Workspace Events

Each workspace maintains a continuous real-time stream of events that describe activities and interactions:

Workspaces work with two main types of events:

Native Events: Automatically generated by the platform (updates, webhooks, errors, automation executions, etc.)
Custom Events: Emitted by your automations or installed apps

Events are stored for up to 3 years and can be viewed/searched from the Activity view of the workspace.

Events from workspaces inactive for longer than 15 days and with fewer than 100 events are regularly deleted. Events from deleted workspaces are kept for up to 6 months after deletion.

Workspace Secrets

Secrets provide a secure way to store sensitive information like API keys, passwords, and access tokens.

Secrets can be used in:

Workspace Configuration:

config:
  value:
    headers:
      apiKey: '{{secret.apiKey}}'

Repository Configuration:

repositories:
  github:
    name: My Repository
    type: git
    mode: read-write
    config:
      url: https://github.com/YourUser/your-repository.git
      branch: main
      auth:
        user: 'your git user'
        password: '{{secret.gitPassword}}'

Secrets beginning with prismeai_* are reserved for super admins to configure system settings.

Version Control

Workspace versioning allows you to save the current state of your workspace to a remote git repository, providing backup, history, and collaboration capabilities.

Configure version control in your workspace source code:

repositories:
  github:
    name: My GitHub Repository
    type: git
    mode: read-write
    config:
      url: https://github.com/YourUser/your-repository.git
      branch: main
      auth:
        user: 'your git user'
        password: '{{secret.gitPassword}}'

Different authentication methods are supported:

Username/Password: For basic authentication
Personal Access Tokens: For services like GitHub (use as password)
SSH Keys: For secure key-based authentication

You can configure multiple repositories with different access modes:

read-write (default): Both push and pull operations
read-only: Only pull operations
write-only: Only push operations

When pulling from a repository, you can exclude specific parts of your workspace from being overwritten:

repositories:
  github:
    name: My GitHub Repository
    type: git
    mode: read-write
    config:
      url: https://github.com/YourUser/your-repository.git
      branch: main
    pull:
      exclude:
        - path: 'index'  # Don't override workspace config
        - path: 'security'  # Don't override security files
        - path: 'pages/custom'  # Don't override 'custom' page

This is useful for preserving local customizations while still getting updates from the shared repository.

After each archive import or repository pull, a workspaces.imported event is emitted with details:

{
 "files": [
  "index",
  "security",
  "pages/test.yml",
   ...
 ],
 "deleted": [
  "automations/removedAutomation.yml"
 ],
 "version": {
  "name": "latest",
  "repository": {
   "id": "yourRepositoryId"
  }
 },
 "errors": [
  {
   "msg": "Could not rename workspace slug from {oldSlug} to {newSlug} as it is already used by workspaceId zlkpbRF",
   "err": "SlugAlreadyInUse",
   "conflictingWorkspaceId": "..."
  }
 ]
}

This event provides a complete record of what changed during the import.

Custom Domains

You can attach a custom domain to your workspace to display pages under your own domain name.

Add DNS Record

Add a CNAME entry to your domain pointing to pages.prisme.ai

For root domains, use an ALIAS record instead of a CNAME.

Configure Workspace

Add the domain to your workspace configuration:

customDomains:
  - www.example.com

Activate Custom Domain

For Enterprise version, contact support to complete the setup.

Contact Support

JSON Schema Form

Workspace configuration often uses JSON Schema Form, a standard for creating declarative complex forms. This is particularly important for app configuration.

A schema form starts with a single field, typically of type “object”:

type: 'object'
properties:
  firstname:
    type: string
  lastname:
    type: string

This creates a form with two fields, producing an object with “firstname” and “lastname” properties.

Schema forms support advanced features:

Custom Widgets

properties:
  description:
    type: string
    ui:widget: textarea
  birthdate:
    type: string
    ui:widget: date
  color:
    type: string
    ui:widget: color

Conditional Fields (oneOf)

properties:
  paymentType:
    oneOf:
      - title: Credit Card
        value: creditCard
        properties:
          cardNumber:
            type: string
            title: Card Number
      - title: Bank Transfer
        value: bankTransfer
        properties:
          accountNumber:
            type: string
            title: Account Number

Arrays and Objects

properties:
  contacts:
    type: array
    title: Contacts
    items:
      type: object
      properties:
        name:
          type: string
        email:
          type: string

Schema forms include validation rules:

properties:
  email:
    type: string
    title: Email
    pattern: "^[\\w-\\.]+@([\\w-]+\\.)+[\\w-]{2,4}$"
    errors:
      pattern: "Please enter a valid email address"
  password:
    type: string
    title: Password
    ui:widget: password
    minLength: 8
    errors:
      minLength: "Password must be at least 8 characters"

This example validates email format and password length, with custom error messages.

Here’s a more complete schema form example:

type: object
title: My Cool Form
description: This is an example of form
properties:
  firstName:
    type: string
    title: Firstname
  lastName:
    type: string
    title: Lastname
  birthdate:
    type: string
    ui:widget: date
    title: Birthdate
  genre:
    type: string
    title: Genre
    enum:
      - 1
      - 2
      - 3
    enumNames:
      - Man
      - Woman
      - Other
  address:
    type: string
    ui:widget: textarea
  hobbies:
    type: object
    title: Your hobbies
    properties:
      favoriteMusic:
        type: array
        title: Favorite music
        items:
          type: string
          title: Type an artist name

This form collects personal information with various field types and widgets.

Next Steps

Automations

Create backend processes and workflows

Pages

Build interactive user interfaces

RBAC

Configure security and access control

Overview

AI SecureChat

AI Store

AI Knowledge

AI Builder

AI Governance

AI Collection (beta)

AI Insights (beta)

What is a Workspace?

Workspace Configuration

Workspace Events

Workspace Secrets

Version Control

Custom Domains

JSON Schema Form

Next Steps

Automations

Pages

RBAC

Overview

AI SecureChat

AI Store

AI Knowledge

AI Builder

AI Governance

AI Collection (beta)

AI Insights (beta)

​What is a Workspace?

​Workspace Configuration

​Workspace Events

​Workspace Secrets

​Version Control

​Custom Domains

​JSON Schema Form

​Next Steps

Automations

Pages

RBAC

What is a Workspace?

Workspace Configuration

Workspace Events

Workspace Secrets

Version Control

Custom Domains

JSON Schema Form

Next Steps