Docs

Comprehensive documentation for FlowX.AI, the AI-driven process automation platform.

Docs

• Context Retrieval: Query Knowledge Bases and retrieve relevant chunks using RAG search without calling an LLM.
• Extract Data from File: Configure the Extract Data from File AI node to extract text and data from documents and ima…
• Intent Classification: Classify user messages and route workflows to different branches using AI-powered intent det…
• Memory capabilities: Persist conversation context across messages with automatic session memory retrieval and sum…
• AI node types: Understanding the different AI node types available in Agent Builder for building AI workflo…
• Agent Builder: Create custom AI agents without code using the FlowX Agent Builder - a no-code/low-code plat…
• Speech to Text: Transcribe audio to text within integration workflows.
• Agent Builder use cases: Real-world examples of what you can build with FlowX.AI Agent Builder.
• Web Page Extractor: Collect readable content from web page URLs with configurable crawling depth, link following…
• AI in FlowX: AI agents for every stage - config-time agents help you build apps faster, while business ag…
• AI Platform setup: Infrastructure requirements, service configuration, and deployment guide for the FlowX.AI AI…
• AI providers and model configuration: Configure AI providers and assign default and fallback models per workspace type for text ge…
• Chat component: Technical reference for the Chat component - runtime behavior, session management, workflows…
• Conversational workflows: Build multi-turn, AI-powered chat experiences with session memory, intent routing, and conte…
• Evaluations: Score AI node outputs against test cases using LLM-as-judge, RAG-quality, and code evaluator…
• AI integrations: Connect AI agents to external data sources, APIs, and knowledge bases.
• AI comparison and reconciliation: Compare AI-extracted document data against system-of-record values and generate structured e…
• Fan-out extraction: Classify documents by type, then route each to a specialized extraction node with tailored p…
• Hybrid AI + business rules: Combine AI extraction and understanding with deterministic business logic for auditable, exp…
• Intent classification and routing: Classify user input into intent categories and route to specialized handlers. Use the dedica…
• Knowledge base RAG: Ground AI responses in your documents using retrieval-augmented generation with Qdrant vecto…
• AI patterns: Reusable architectural patterns for building AI-powered apps on FlowX.AI.
• Session state management: Manage conversation history and session state across multi-turn interactions using FlowX Dat…
• AI Analyst: Builds and optimizes BPMN processes using AI to generate, validate, and enhance workflows ba…
• AI Assistant: Answers questions about the FlowX.AI platform as well as your organization's business domain…
• AI Designer: Convert natural language prompts, Figma designs, or sketches into complete UI layouts with v…
• AI Developer: Generate specific business rules or code expressions from natural language prompts, without…
• Config-time agents: AI agents built into FlowX Designer that help you create processes, UIs, and business rules…
• Customer onboarding with KYC: Build a multi-step customer onboarding process with identity verification, document generati…
• Document processing pipeline: Build an AI-powered document verification pipeline that classifies uploaded documents, extra…
• Mortgage advisor chatbot: Build a Chat Driven conversational AI mortgage advisor with built-in session memory, intent…
• Tutorials: Step-by-step guides for building real-world AI apps with FlowX.AI, based on production-grade…
• BPMN integration: Trigger AI agents from BPMN workflow nodes for automated document processing, decisions, and…
• Chat interface: Add conversational AI to your applications with the FlowX.AI Chat component.
• Using AI agents: Learn how to integrate and interact with AI agents in your FlowX.AI applications.
• Get build info by process instance: Retrieve the build associated with a running process instance, including the build settings…
• Get build info by UI flow session: Retrieve the build associated with a running UI flow session, including the build settings u…
• Get Build Info: Retrieve the active build for an app and workspace. Returns the buildId you need to start a…
• Start process by build id and process name: Start a FlowX process from your own app or backend by specifying the appId, buildId, and pro…
• Start process by workspace, app, and process name: Start a process using the workspace's active build — the simplest public REST entry point fo…
• Start process from UI with resource definition and inherit values: Start a process by resource definition ID and inherit parameter values from a related proces…
• Start process and copy data from another instance: Start a new process whose initial data is copied from an existing process instance — useful…
• Node actions: Actions define the activities that a node handles. Actions have various types and specify co…
• Append params to parent process: It is a type of action that allows you to send data from a subprocess to a parent process.
• Business rules types: A business rule is an action type in FlowX.AI that allows you to configure a script on a BPM…
• Extracting additional data in business rules: Business rules in FlowX.AI allow you to extract and use key values dynamically. This is esse…
• Kafka send action: The FlowX.AI Designer offers various options to configure the Kafka Send Action through the…
• Send data to user interface: Push real-time updates from the process to the client over a single long-lived HTTP connecti…
• Send notification action: Send emails directly from process nodes using the Send Notification action. Supports both ne…
• Start integration workflow action: The Start Integration Workflow action initiates a configured workflow to enable data process…
• Start new project instance: Initiate a new main process from within an ongoing process to handle isolated use cases acro…
• Start subprocess action: A Start subprocess action is an action that allows you to start a subprocess from another (p…
• Upload file action: An Upload File action is an action type that allows you to upload a file to a service availa…
• Call activity node: The Call Activity node is a custom node type in the main process that provides advanced opti…
• Start embedded subprocess: The Start Embedded Subprocess node initiates subprocesses within a parent process, allowing…
• Error events: Error Events expand the capabilities of process modeling and error handling within BPMN proc…
• Exclusive gateway: In the world of process flows, decisions play a crucial role, and that's where the Exclusive…
• Message catch boundary events: Trigger interrupting or non-interrupting boundary events on user tasks when an incoming mess…
• Message Start Event: Start a process instance when a specific message, incoming email, or incoming webhook is rec…
• Message Events: Message events serve as a means to incorporate messaging capabilities into business process…
• Intermediate message events in business processes: Orchestrate information exchange and synchronize stages within a process using Intermediate…
• Message catch intermediate event: A Message Catch Intermediate Event is a type of event in a process that waits for a specific…
• Message intermediate events overview: Overview of BPMN message intermediate events for throwing and catching messages within proce…
• Message throw intermediate event: A Message Throw Intermediate Event is an event in a process where a message is sent to trigg…
• Send message/receive message tasks: Send message task and Receive message task nodes are used to handle the interaction between…
• Process nodes (BPMN): A Business Process Model and Notation (BPMN) node is a visual representation of a point in y…
• Parallel gateway: Run independent tasks concurrently in a process by opening and closing a parallel section wi…
• Start/end nodes: Let's go through all the options for configuring start and end nodes for a process definitio…
• Service Task node: A service task node refers to a task that utilizes various services, such as Web services, a…
• Timer boundary event: Attach a BPMN event to a task or subprocess that activates when a duration, deadline, or spe…
• Timer events: Trigger BPMN actions or events at predefined intervals, durations, or cycles to add time-bas…
• Timer expressions: Configure timer expressions using Cron syntax for scheduling or ISO 8601 format for duration…
• Timer Intermediate Event (interrupting): A Timer Intermediate Event (interrupting) is an event that is triggered based on a specified…
• Timer start event (interrupting): A Timer Start Event initiates a process instance based on a specified time or schedule.
• User task node: This node represents an interaction with the user. It is used to display a piece of UI (defi…
• Data mappers: Visually map data transfers between components while maintaining full backward compatibility.
• Process data model: Manage key-value attributes inside process definitions, supporting strings, numbers, boolean…
• Process design principles: Foundational principles for designing FlowX processes. Covers modal usage, subprocess lifecy…
• Navigation areas: Navigation areas play a pivotal role in user interface design. They enhance the user experie…
• Navigation best practices: Guidelines for choosing the right navigation patterns, understanding valid combinations, and…
• Passing data between nodes: How outputs from subprocesses, workflows, AI agents, and business rules land in process vari…
• Permission-based expressions: Control UI element visibility and interaction based on user roles, usernames, and process da…
• Process Designer: The Process Designer workspace is tailored for creating and editing business processes, feat…
• Process definition: The core of the platform is the process definition, which is the blueprint of the business p…
• Subprocess management: Learn how to configure, start, and execute subprocesses efficiently within your process flow.
• Project data model: Define reusable data types at the project level to ensure consistency across processes
• Custom Components: Create custom React components that integrate with FlowX process data and actions, extending…
• Reusable Functions: Create and manage business logic components that can be reused across multiple processes in…
• Reusable UI Templates: Create and manage modular UI components that can be used across multiple User Tasks and proc…
• Supported scripts: Scripts are used to execute actions and configure properties inside nodes. The following scr…
• Token: Token represents the current position in the process flow. When you start a process, you hav…
• UI Designer best practices: Best practices for creating effective user interfaces using FlowX.AI UI Designer, based on e…
• Conditional styling: Dynamically update styling and properties of UI elements based on conditions, reducing the n…
• Dynamic & computed values: Build dynamic, interactive UIs with dynamic and computed values that deliver personalized an…
• Event Handlers: Configure how UI components respond to user interaction and lifecycle events — run node acti…
• Layout configuration: Layout settings are available for all components that can group other types of elements (for…
• Localization and internationalization: FlowX.AI localization and internationalization adapt applications to different languages, re…
• Platform-specific considerations: Platform-specific configuration, limitations, and best practices for Web, iOS, and Android p…
• Screen configuration guide: Learn how to configure screens effectively using FlowX.AI UI Designer with platform-specific…
• Buttons: Interactive button components for triggering actions and file uploads with comprehensive sty…
• Chat: Enable interactive AI agent conversations with end-users through a conversational interface…
• Collection: The Collection component functions as a versatile container element, allowing you to iterate…
• Collection Prototype: Create dynamic, data-driven interfaces with different layouts based on item properties using…
• File preview: Preview file contents inside a UI flow without fully opening the file, using the File Previe…
• Checkbox: A checkbox form field is an interactive element in a web form that provides users with multi…
• Datepicker: The datepicker (Calendar Picker) is a lightweight component that allows end users to enter o…
• Input field: Enable users to input and validate various types of data with flexible configuration options…
• Multi select: The Multi Select form field is an element that allows users to choose multiple options from…
• Radio: Radio buttons are normally presented in radio groups (a collection of radio buttons describi…
• Segmented button: It allows you to pick only one option from a group of options, and you can choose to have be…
• Single Select: Enable users to choose from a dropdown list of predefined options with advanced features inc…
• Slider: It allows you to pick only one option from a group of options, and you can choose to have be…
• Switch: Enable users to toggle between two states with an intuitive switch interface that stores boo…
• Text area: Capture multi-line input from users for longer responses such as descriptions, comments, or…
• Image: Image UI elements are graphical components of a user interface that display a static or dyna…
• Indicators: The indicators (Message UI elements) allow you to display different types of messages.
• Markdown: A UI component that renders Markdown-formatted content on a screen.
• Multiple file upload: A drag-and-drop upload component that lets users select and upload multiple files in a singl…
• Progress bar: A UI component for visualizing progress or completion state on a screen.
• Card: A card in FlowX.AI is a graphical component designed for the purpose of grouping and alignin…
• Container: A container in FlowX.AI is a versatile building block that empowers you to group components…
• Custom component: Custom components are developed in the web application and referenced here by component iden…
• Root Components in UI Design: Root components serve as the foundation for structuring user interfaces, providing the frame…
• Separator: A visual divider component used to group and separate UI content in screens.
• Table: The Table component is a versatile UI element allowing structured data display with customiz…
• Tooltip: A UI component that displays additional context on hover or focus, with configurable icon an…
• Typography: Typography is an important aspect of design that greatly influences how users perceive and i…
• UI Designer: The FlowX.AI UI Designer is a comprehensive, multi-platform interface creation tool that ena…
• Validators: Apply pre-defined validation rules to form inputs such as text, number, email, and date fiel…
• UI Flows: Build reusable, multi-platform user interfaces that work across web, iOS, and Android withou…
• Fonts: Fonts management allows you to upload and manage multiple font files, which can be later uti…
• Global Media Library: System assets serve as a centralized hub for managing and organizing various types of media…
• Themes: Theme management enables you to change the appearance and styling of your app. Personalize t…
• Adding a new node: Learn how to add and configure different node types to build process flows in FlowX.AI Desig…
• Adding an action to a node: Learn how to enhance your process flows by adding actions to nodes for business rules, data…
• Adding parallel flow branches: Learn how to create concurrent process flows using parallel gateways to execute multiple act…
• Creating and managing process definitions: Learn how to create new process definitions and manage them using operations like export, du…
• Creating a new project: Learn how to create and configure a new project in FlowX.AI Designer
• Creating a User interface: Learn how to design and configure engaging user interfaces for your process flows using Flow…
• Exporting and importing projects: Learn how to transfer projects between environments using the export and import functionalit…
• Handling decisions in the flow: Learn how to implement conditional branching in your processes using exclusive gateways to c…
• Moving a token backwards in a process: Learn how to implement "Back" functionality in your processes to allow users to return to pr…
• Initiating/starting processes: Learn the different methods for starting process instances in FlowX.AI, including user inter…
• FlowX.AI Designer: The FlowX.AI Designer is a collaborative, no-code, web-based application development environ…
• Tutorial: Build a credit card application: Learn FlowX.AI by building a complete credit card request flow with forms, integrations, and…
• FlowX.AI documentation: Build enterprise applications and deploy AI agents for banking, insurance, and logistics
• Accessibility: WCAG 2.1 Level AA accessibility support in FlowX.AI, including screen reader compatibility,…
• FlowX.AI Advancing Controller: The Advancing Controller is a support service for the FlowX.AI Engine that enhances the effi…
• FlowX.AI Events Gateway: The FlowX Events Gateway is a service that centralizes the communication with Server-Sent Ev…
• FlowX.AI Engine: Core service that runs process definitions, generates UI, and communicates with the frontend…
• FlowX.AI Audit: The Audit service provides a centralized location for all audit events. The following detail…
• Configuration parameters: Manage variables and values that change across deployment environments (Development, QA, Pro…
• FlowX.AI CMS: The FlowX.AI Headless Content Management System (CMS) is a core component of the FlowX.AI pl…
• Combining files: You can combine multiple files into a single document using the Documents plugin.
• Converting files: Convert documents between formats using the Documents Plugin. Supports PDF to JPEG conversio…
• Deleting files: The Documents plugin provides functionality for deleting files.
• Document Templates: You can add Document Templates to your custom FlowX.AI deployment to enhance the core platfo…
• Encrypting and decrypting files: Learn how to encrypt and decrypt files using the Documents plugin via Kafka messaging.
• Generating documents: Generate new documents from custom templates that can be pre-filled with data from the curre…
• Getting URLs: In certain scenarios, obtaining URLs pointing to uploaded documents for use in integrations…
• Listing stored files: View files stored in S3-compatible buckets (such as MinIO or Amazon S3) using the Documents…
• Managing templates: The Documents plugin provides the flexibility to define and manage HTML templates for docume…
• Splitting documents: You can split a document into multiple parts using the Documents plugin.
• Creating and uploading a new document: A comprehensive guide to integrating document creation from templates, managing uploads, and…
• Enumerations: Enumerations allow you to manage a collection of predefined values that can be used within U…
• Media library: Centralized hub for managing PDFs, images, GIFs, and other media files uploaded to processes.
• Forwarding notifications: If the Notification service is not directly connected to an SMTP / SMS server and you want t…
• Managing notification templates: You can create and manage notification templates using FlowX.AI Designer by accessing the de…
• Notification Templates: You can add Notification Templates to your custom FlowX.AI deployment. The plugin will **enh…
• Generate OTP: There are some cases when you will need to generate an OTP (One Time Password) from a busine…
• Handling OTP: The notifications plugin can also be used for handling the one time password (OTP) generatio…
• Validate OTP: Validate one-time passwords (OTP) sent via SMS or email using the Notifications Plugin Kafka…
• Sending a notification: Learn how to configure and implement notification functionality in your business processes u…
• Sending an email: To use the notification plugin for sending emails with attachments, you must define the same…
• Substitution tags: Substitution tags are used to generate dynamic content across the platform. As **enumeration…
• FlowX.AI Scheduler: The Scheduler is part of the core extensions of the FlowX.AI platform. You can add it to you…
• FlowX.AI Data Search: Search for specific data across process instances using Elasticsearch-powered indexing for f…
• Task Management localization: Comprehensive localization support for Task Management, enabling multi-language experiences…
• Task management: Task Management tracks work items generated by running processes, giving teams visibility in…
• Using allocation rules: Allocation rules automatically assign tasks to users as tokens enter a swimlane, distributin…
• Using out of office records: The Out-of-office feature allows you to register users availability to perform a task. It ca…
• Using stages: You can define specific stages during the execution of a process. Stages are configured on e…
• Building a connector: Build custom connectors to integrate external systems with FlowX.AI as independently deploya…
• Consuming FlowX from external apps: Choose the right integration pattern when calling FlowX from your own code — embed the UI wi…
• Creating a Kafka consumer: This guide focuses on creating a Kafka consumer using Spring Boot.
• Creating a Kafka producer: This guide focuses on creating a Kafka producer using Spring Boot.
• Custom Agent node: Create AI agents with advanced capabilities using MCP tools to execute complex tasks in Inte…
• Email Sender: Configure SMTP email connections as data sources to send emails directly from your FlowX.AI…
• Email Trigger: Configure email-based process triggers to automatically start process instances when emails…
• File Storage: Connect to external file storage (FTP, SFTP, S3, or Azure Blob) as a data source and move fi…
• Finding identifiers and parameters: A comprehensive reference guide for locating identifiers, UUIDs, and parameters required for…
• FlowX Database: Store and access structured data between processes and applications
• Incoming Webhooks: Trigger FlowX processes when an external system sends an HTTP POST. Secure with API keys, ev…
• Integration Designer: Connect FlowX to external systems via REST APIs using a drag-and-drop interface for data mod…
• Overview: Integrations connect legacy systems, third-party applications, and external data sources to…
• Knowledge Base integration: Learn how to create and manage FlowX Knowledge Bases to provide AI agents with contextual in…
• Managing stores: Learn how to upload documents, manage stores, and work with chunks in FlowX Knowledge Bases.
• Testing a knowledge base: Test create, append, replace, delete, edit-metadata, and query operations against a knowledg…
• Using Knowledge Base in workflows: Learn how to query Knowledge Bases using Custom Agent and Context Retrieval nodes in workflo…
• MCP Data Sources: Learn how to add, configure, and manage MCP servers as data sources in Integration Designer.
• MCP integration: Learn how to integrate Model Context Protocol (MCP) servers with FlowX.AI to enable AI agent…
• Microsoft Outlook: Connect to Microsoft Outlook via MS Graph API to read and send emails directly from your Flo…
• Mock integrations: If you need to test the business process flow but haven't completed all integrations, you ca…
• Observability with OpenTelemetry: Monitor and analyze FlowX.AI platform performance using OpenTelemetry for distributed tracin…
• Oracle Database: Connect to Oracle databases as a data source in FlowX workflows and run SQL queries against…
• Proxy connections: Create and manage reusable proxy connections to route data source traffic through HTTP or HT…
• Unmanaged MongoDB: Connect to externally managed MongoDB instances as a data source in FlowX workflows.
• Workflow data model: Define structured data models at the workflow level with input and output parameters, enabli…
• FlowX custom plugins: Adding new capabilities to the core platform can be done by using plugins. FlowX plugins rep…
• OCR plugin: The OCR (Optical Character Recognition) plugin is a tool that enables you to read barcodes a…
• Authorization & access roles: Configure authorization and access roles for the Reporting plugin using Keycloak integration…
• Reporting plugin: Build custom and technical reports from BPMN process data and process instance data, integra…
• WYSIWYG editor: Create and edit notification and document templates in FlowX Designer with the WYSIWYG (What…
• Third-party components: FlowX.AI uses a number of third-party software components
• Anonymous runtime access: Run processes and UI flows for unauthenticated users using the built-in Anonymous role and t…
• Business filters: An optional attribute, from the authorization token, that can be set to restrict access to p…
• Swimlanes: Swimlanes provide a way of grouping process nodes by process participants.
• Data architecture: Which data stores FlowX.AI uses, what each stores, and how they fit together.
• FlowX.AI architecture: FlowX.AI is built on a layered microservices architecture with event-driven communication. T…
• Intro to BPMN: A process represents your business use case, such as requesting a credit card, placing a foo…
• Intro to Elasticsearch: Integrate Elasticsearch into event-driven architectures and workflows to efficiently index a…
• Intro to Kafka concepts: Apache Kafka is an open-source distributed event streaming platform that can handle a high v…
• Intro to Kubernetes: Kubernetes is an open-source container orchestration platform that automates many of the man…
• Intro to NGINX: NGINX is a free, open-source, high-performance web server with a rich feature set, simple co…
• Intro to Redis: Open-source, in-memory key-value data store used as a cache for fast access to frequently us…
• Projects: Projects group all resources and dependencies needed to implement an use case.
• Dependencies: Manage dependencies between projects and libraries to enable resource sharing, modular devel…
• Libraries: Libraries are specialized projects that serve as reusable containers for resources that can…
• Versioning: Easily track and manage your project's evolution with comprehensive versioning features.
• Reference types in resources usage: Understanding how Reference Type values are determined in the Resource Usage Overview and wh…
• Resources: Overview of Global and project resources, including their usage, dependencies, promotion, an…
• Active policy: The Active policy defines the strategy for selecting which build version of a project is act…
• Failed process start (exceptions): View and debug exceptions that occur when process instances fail to start, including detaile…
• Process instance: A process instance is a specific execution of a business process that is defined on the Flow…
• Update process variables: Modify process variables on active process instances to resolve production issues without re…
• Builds: The Build feature allows for the creation of deployable packages of a project, encapsulating…
• Configuration parameters overrides: The Configuration parameters overrides feature allows you to set environment-specific values…
• Manage Triggers: Monitor and control event-based triggers that automatically start process instances. Manage…
• Scheduled processes: Automate process instance creation on specific dates, times, or intervals using Start Timer…
• UI Flow Sessions: Monitor and manage active UI Flow sessions, track session activity, and view audit logs. UI…
• Workspaces: Workspaces enable organizations to manage multiple business contexts within one FlowX instan…
• Container app authentication: Configure authentication flows, landing pages, and session management for container applicat…
• Container app branding: Customize the visual appearance of the SaaS container app with organization-level branding s…
• Inviting Users: Learn how Organization Admins can invite designer users to their organization via email with…
• Organization settings: Configure AI providers, manage access, design assets, and platform settings for your FlowX o…
• FlowX SaaS Overview: Learn about FlowX.AI SaaS deployment model and multi-tenant architecture.
• Android SDK: Migrate the FlowX Android renderer SDK from 5.1.x LTS to 5.9.x.
• Angular SDK: Migrate the FlowX Angular renderer SDK from 5.1.x LTS to 5.9.x.
• API & integration breaking changes: REST endpoint renames, removals, mandatory headers, and token-format changes that custom API…
• Authentication & IAM migration: Keycloak two-realm architecture, service-account renames, opaque-token removal, and the new…
• Engine partitioning configuration: The process-instance partitioning and archiving configuration consolidated under flowx.data.…
• Ingress routing and CORS: NGINX ingress controller no longer assumed, CORS handling moved to the application layer, an…
• iOS SDK: Migrate the FlowX iOS renderer SDK from 5.1.x LTS to 5.9.x.
• Kafka migration: One mandatory new header, new Kafka topics that did not exist in 5.1.x, a topic-ownership mo…
• License and organization configuration: ORGANIZATION_ID Liquibase parameter on the 9 services that backfill org_id columns, the lice…
• Migrating from 5.1 LTS: Plan and execute a direct upgrade from FlowX.AI 5.1.x LTS to 5.9.x LTS.
• Prerequisites & upgrade path: Audience, supported source versions, and the inventory you should gather before starting the…
• React SDK: Migrate the FlowX React renderer SDK from 5.1.x LTS to 5.9.x.
• Runtime authorization migration: How runtime roles, end-user groups, and solution sharing change between FlowX.AI 5.1.x and 5…
• EU AI Act: 18 EU AI Act requirements mapped to Observatory controls, with scope by risk tier.
• Gap analysis & heatmap: Cross-framework view that prioritises remediation by the impact of closing each gap.
• ISO 42001: 12 ISO/IEC 42001:2023 requirements mapped to Observatory controls for AI management systems.
• NIST AI RMF: 16 NIST AI Risk Management Framework requirements mapped to Observatory controls across Gove…
• Compliance: EU AI Act, NIST AI RMF, and ISO 42001 mapped to your runtime — controls evaluated continuous…
• Getting started: Connect your first project, instrument an agent, and see traces in Observatory in under 15 m…
• AI Registry: Catalogue every model, deployment, and owner across your portfolio — the inventory layer for…
• Assessments: Dynamic, weighted-scoring questionnaires for repeatable governance reviews.
• Evidence: Collect, review, and approve evidence for governance controls — automated and manual, with g…
• Governance: Policy engine, risk scoring, evidence collection, and assessments — the controls layer for p…
• Policies: Define, assign, and evaluate governance rules. Bundle rules into packs. Track compliance acr…
• Risk Dashboard: Six-dimensional risk scoring per app, rolled up to the org for leadership visibility.
• Alerts: Threshold-based alerting with cooldowns and SLA tracking across eight LLM metrics.
• Analytics: Cost, latency, error rate, and model performance trends across all your projects.
• Drift Monitor: Distribution-level monitoring across five metrics, with composite scoring and timeline chart…
• LLM Calls: A searchable, filterable table of every LLM invocation from every project, with full input a…
• Observability: Real-time tracing, analytics, drift detection, and threshold alerts for every LLM call, chai…
• Threads: Multi-turn conversations grouped from chat events, with per-message latency, cost, and feedb…
• Traces: The chain-of-calls view for a single run — every chain, tool call, and event with timings an…
• Observatory: Observe, govern, and prove the value of every AI agent running on FlowX from one platform.
• Compliance ROI: Quantify audit-labour savings and risk reduction from automated governance and evidence coll…
• Financial ROI: Per-agent and per-project payback period, annual ROI %, and 5-year Net Present Value.
• ROI & value: Risk-adjusted financial ROI, Value Outcome Units, and Monte Carlo sensitivity — board-grade…
• Sensitivity analysis: Monte Carlo simulations across ROI inputs to show confidence ranges instead of single-point…
• Value Outcome Units: Group agents by business outcome so technical metrics translate to board-level revenue and c…
• Decorators: Reference for the @agent, @chain, and @tool decorators that auto-instrument your code.
• Event reporting: The event protocol, custom events, and how saved and chat shape downstream views.
• SDK overview: Install the Observatory Python SDK, configure the API key, and learn where instrumentation b…
• Environment variables: Reference for the environment variables each Observatory service reads.
• Self-hosted setup: Stand up Observatory locally with Docker Compose for development, evaluation, or on-premise…
• Android SDK: Install and configure the FlowX.AI Android SDK to render process-driven UI in native Android…
• Angular SDK: The Angular renderer SDK renders UI configured in the FlowX Designer as a standalone Angular…
• iOS SDK: Install and configure the FlowX.AI iOS SDK to render process-driven UI in native iOS apps. R…
• React Native SDK: The React Native renderer SDK renders processes configured in the FlowX Designer inside a Re…
• React SDK: The React renderer SDK renders UI configured in the FlowX Designer as a standalone React com…
• SDKs overview: FlowX.AI web and native mobile SDKs auto-generate UIs from business process definitions for…
• IAM solution: Identity and access management (IAM) framework of processes, policies, and technologies for…
• Configuring an IAM solution (Keycloak): This guide provides step-by-step instructions for configuring a minimal Keycloak setup to ma…
• Configuring an IAM solution (EntraID): This guide provides step-by-step instructions for configuring a minimal EntraId setup to man…
• End-user access management: Manage end-user roles, groups, and attributes for controlling access to published solutions…
• Permission reference guide: Technical reference for FlowX Designer permissions, naming conventions, and UI mappings
• Role selection & management guide: Practical guidance for selecting and assigning the right roles in FlowX Designer
• Complete roles & permissions matrix: Detailed permission matrices for all FlowX roles across organization, workspace, and project…
• Runtime authorization: Project-scoped roles, end-user groups, and solution sharing for controlling who can access a…
• Workspaces access rights: Overview of FlowX workspaces access rights and role-based access control
• FlowX Admin setup: Complete configuration reference for the FlowX Admin microservice, including logging, databa…
• FlowX Advancing Controller setup: This guide provides step-by-step instructions to help you configure and deploy the Advancing…
• AI Gateway setup: Set up the AI Gateway microservice — powers the AI chat experience in the FlowX Designer, st…
• Application Manager setup: Set up the Application Manager backend microservice for managing FlowX apps, libraries, vers…
• Audit setup: This guide will walk you through the process of setting up the Audit service and configuring…
• Authorization system setup: Configure these environment variables for the authorization-system microservice deployment.
• FlowX CMS setup: Set up the FlowX CMS Docker microservice for managing taxonomies and content inside an app.
• Data-Sync job setup: Comprehensive guide for configuring and deploying the Data-Sync Job in your Kubernetes envir…
• FlowX Designer setup: To set up FlowX Designer in your environment, follow this guide.
• Document Parser setup: Configure the Document Parser service for document text extraction, OCR processing, and AI-p…
• Documents plugin setup: The Documents plugin provides functionality for generating, persisting, combining, and manip…
• Email Gateway setup: This guide provides step-by-step instructions for setting up the Email Gateway microservice.
• FlowX Events Gateway setup: This guide will walk you through the process of setting up the events-gateway service.
• File Gateway setup: Set up the File Gateway microservice — ingests files from FTP, SFTP, S3, and Azure Blob stor…
• Configuring access roles for processes: Learn how to set up user role-based access control for process definitions using swimlanes,…
• Configuring Elasticsearch indexing: This guide shows you how to enable process instance indexing using either Kafka or HTTP tran…
• Indexing config guidelines: Guidelines for sizing and configuring Elasticsearch for process instance indexing based on a…
• FlowX Engine setup: This guide provides instructions on how to set up and configure the FlowX.AI Engine.
• Partitioning & archiving: Improving data management using data partitioning and the archival processes.
• Routing: How FlowX services are exposed externally on 5.9.x, the per-service route table, and CORS ha…
• Integration Designer setup: This guide explains how to configure the Integration Designer service using environment vari…
• Kafka Authentication profile: Enable secure Kafka communication across Java microservices using Spring configuration profi…
• License service setup: Set up the License service (formerly License Engine) — manages platform and application lice…
• ModPod setup: Configure the ModPod service for ML model serving with LightGBM, scikit-learn, and SHAP expl…
• NoSQL DB Runner: Set up the NoSQL DB Runner microservice that powers FlowX Database with MongoDB and Azure Co…
• Notifications plugin setup: The Notifications plugin is available as a Docker image, and it has the following dependenci…
• Deployment configuration for OpenTelemetry: Guide to deploying OpenTelemetry components and configuring associated services.
• Organization Manager setup: This guide provides step-by-step instructions for setting up the Organization Manager micros…
• Open Telemetry default properties: Default OpenTelemetry configuration properties for FlowX.AI services, including Java agent s…
• OCR plugin setup: The OCR plugin is a Docker image that can be deployed using the following infrastructure pre…
• Plugins setup: To set up a plugin in your environment, you must go through the next steps.
• Reporting setup: The Reporting setup guide assists in configuring the reporting plugin, relying on specific d…
• Redis configuration: Configure Redis deployment modes for FlowX platform services
• Runtime manager setup: This guide provides a step-by-step process for setting up and configuring the Runtime Manage…
• Scheduler setup: This guide will walk you through the process of setting up the Scheduler service.
• FlowX Data Search setup: Comprehensive guide for installing, configuring, and deploying the FlowX Data Search service
• Microservices setup guides: Complete reference for deploying and configuring FlowX.AI microservices in your environment
• Speech to Text setup: Configure the Speech to Text service for audio transcription and text-to-speech capabilities.
• SpiceDB setup: This guide covers the step-by-step installation and configuration of SpiceDB for FlowX deplo…
• Task management setup: Configure and deploy the Task Management plugin as a Docker microservice within the FlowX pl…
• Web Crawler setup: Configure the Web Crawler service for web page crawling, content extraction, and AI-driven b…
• Webhook Gateway setup: Set up the Webhook Gateway microservice — the public endpoint that receives incoming webhook…
• Release Notes
• Deployment guidelines v3.0
• v3.0.0 February 2023: We are excited to announce the release of FLOWX.AI 3.0 🔥, featuring new and improved featur…
• Deployment guidelines v3.1.0
• v3.1.0 March 2023: Drumroll please... 🥁 We are excited to announce FLOWX.AI 3.1 release 🔥.
• Deployment guidelines v3.2.0
• v3.2.0 April 2023: Drumroll please... 🥁 We are excited to announce FLOWX.AI 3.2 release 🔥.
• Deployment guidelines v3.3.0
• v3.3.0 July 2023: We can't reinvent the wheel... but we can certainly give it a whole new spin! Drumroll, plea…
• Deployment guidelines v3.4.0
• v3.4.0 September 2023
• Deployment guidelines v3.4.1
• v3.4.1 September 2023
• Deployment guidelines v3.4.2
• v3.4.2 October 2023: Welcome to the FLOWX.AI v3.4.2 patch release! This update brings several enhancements and fi…
• Deployment guidelines v3.4.3
• v3.4.3 October 2023: In FLOWX.AI version 3.4.3, we've addressed several bugs to improve the stability and reliabi…
• Deployment guidelines v3.4.4
• v3.4.4 November 2023
• Deployment guidelines v3.4.5
• v3.4.5 November 2023
• Deployment guidelines v3.4.6
• v3.4.6 December 2023
• Deployment guidelines v3.4.7
• v3.4.7 January 2024
• Deployment guidelines v3.4.8
• v3.4.8 June 2024
• Deployment guidelines v4.0
• Deployment changes: This document outlines the additional configuration changes required for deployment in versi…
• Process configuration: This guide outlines changes in process and UI configuration from v3.4.x to 4.0 version.
• Renderer SDKs: This guide assists in migrating from FlowX v3.4.x to v4.0.
• UI components - change log: This log outlines the changes in component styles and props from version 3.4.x to version 4.…
• FlowX.AI 4.0.0 Release Notes: 🎉 Welcome to the much-anticipated FlowX.AI 4.0 release! 🚀 Get ready to experience a whole…
• Deployment guidelines v4.1
• Migrating from previous versions to v4.1
• Components change log v4.1: This log outlines the changes in component styles and props from v4.0 to v4.1.
• FlowX.AI 4.1.0 Release Notes (LTS): 🎉 Welcome to the FlowX.AI 4.1.0 release!
• Deployment guidelines v4.1.1
• Migrating from previous versions to v4.1.1
• FlowX.AI 4.1.1 Release Notes (LTS)
• Deployment guidelines v4.1.2
• Migrating from previous versions to v4.1.2
• FlowX.AI 4.1.2 Release Notes (LTS)
• Deployment guidelines v4.1.3
• Migrating from previous versions to v4.1.3
• FlowX.AI 4.1.3 Release Notes (LTS)
• Deployment guidelines v4.1.4
• Migrating from previous versions to v4.1.4
• FlowX.AI 4.1.4 Release Notes (LTS)
• Deployment guidelines v4.1.5
• Migrating from previous versions to v4.1.5
• FlowX.AI 4.1.5 Release Notes (LTS)
• Deployment guidelines v4.2.0
• FlowX.AI 4.2.0 Release: We are excited to announce the release FlowX.AI 4.2 🔥, featuring new and improved features…
• Deployment guidelines v4.2.1
• FlowX.AI 4.2.1 Release: We are excited to announce the release FlowX.AI 4.2.1 🔥, featuring new and improved feature…
• Deployment guidelines v4.5.0
• Deployment changes for v4.5.0: This document outlines the configuration and infrastructure changes introduced from v4.1.x t…
• Configuration and migration guide: This guide outlines changes in process and UI configuration from v4.1.x to 4.5.1 version.
• Renderer SDKs: This guide assists in migrating from FlowX v4.1.x to v4.5.0.
• FlowX.AI 4.5.0 Release Notes: Welcome to the FlowX.AI 4.5.0 release! 🚀 This update is packed with groundbreaking features…
• Deployment guidelines v4.5.1
• Deployment changes for v.4.5.1: This document outlines the configuration and infrastructure changes introduced from v4.1.x t…
• Configuration and migration guide: This guide outlines changes in process and UI configuration from v4.1.x to 4.5.1 version.
• Renderer SDKs: This guide assists in migrating from FlowX v4.1.x to v4.5.1.
• FlowX.AI 4.5.1 Release Notes: FlowX.AI 4.5.1 brings essential bug fixes and user experience improvements.
• Deployment guidelines v4.5.2
• FlowX.AI 4.5.2 Release: FlowX.AI 4.5.2 introduces table updates, performance improvements, enhanced plugin integrati…
• Deployment guidelines v4.5.3
• Migrating from older versions to v4.5.3: This document outlines the configuration and infrastructure changes introduced from v4.1.x t…
• Configuration and migration guide: This guide outlines changes in process and UI configuration from v4.1.x to 4.5.1 version.
• Renderer SDKs: This guide assists in migrating from FlowX v4.1.x to v4.5.1.
• FlowX.AI 4.5.3 Release Notes: FlowX.AI 4.5.3 introduces advanced branch merging capabilities, enhanced table customization…
• Deployment guidelines v4.5.4
• FlowX.AI 4.5.4 Release Notes: This internal release brings various enhancements and new features to improve functionality,…
• Deployment guidelines v4.5.5
• FlowX.AI 4.5.5 Release Notes: This release brings various enhancements and new features to improve functionality, usabilit…
• Deployment guidelines v4.5.6
• FlowX.AI 4.5.6 Release Notes: Version 4.5.6 brings enhanced export options for media libraries, key bug fixes, and improve…
• Deployment guidelines v4.5.7
• FlowX.AI 4.5.7 Release Notes
• Deployment guidelines v4.6.0
• Deployment changes for v4.6.0: This document outlines the configuration and infrastructure changes introduced from v4.1.x t…
• Configuration and migration guide: This guide outlines changes in process and UI configuration from v4.1.x to 4.6.0 version.
• Renderer SDKs: This guide assists in migrating from FlowX v4.1.x to v4.6.0.
• FlowX.AI 4.6.0 Release Notes: Welcome, FlowX fam! The 4.6.0 update is here, and it’s packed with features designed to save…
• Deployment guidelines v4.6.1
• Migrating from previous versions to v4.6.1
• FlowX.AI 4.6.1 Release Notes: FlowX.AI 4.6.1 is here with important fixes and improvements to keep things running smoothly…
• Deployment guidelines v4.7.0
• Migrating from previous versions to v4.7.0
• FlowX.AI 4.7.0 Release Notes: FlowX.AI 4.7.0 is here to keep your projects vibing, your merges drama-free, and your config…
• Deployment guidelines v4.7.1
• Migrating from previous versions to v4.7.1
• FlowX.AI 4.7.1 Release Notes: FlowX.AI 4.7.1 brings enhanced resource navigation, better error detection, and workflow imp…
• Deployment guidelines v4.7.10
• FlowX.AI 4.7.10 Release Notes: Latest features, improvements, and bug fixes in our newest release
• Deployment guidelines v4.7.11
• FlowX.AI 4.7.11 Release Notes: Security and maintenance updates for the 4.7.x LTS release
• Deployment guidelines v4.7.2
• Migrating from previous versions to v4.7.2
• FlowX.AI 4.7.2 Release Notes: FlowX.AI 4.7.2 delivers improved merge conflict handling with retry capabilities, deprecates…
• Deployment guidelines v4.7.3
• Migrating from previous versions to v4.7.3
• FlowX.AI 4.7.3 Release Notes: FlowX.AI 4.7.3 enhances workflow conflict resolution, adds configurable enumeration ordering…
• Deployment guidelines v4.7.4
• Migrating from previous versions to v4.7.4
• FlowX.AI 4.7.4 Release Notes: FlowX.AI 4.7.4 enhances system stability with Spring Boot updates and resolves critical issu…
• Deployment guidelines v4.7.5
• Migrating from previous versions to v4.7.5
• FlowX.AI 4.7.5 Release Notes: FlowX.AI 4.7.5 enhances system stability with introducing support for more 3rd party depende…
• Deployment guidelines v4.7.6
• Migrating from previous versions to v4.7.6
• FlowX.AI 4.7.6 Release Notes: This release includes significant improvements to logging configuration and resolves some is…
• Deployment guidelines v4.7.7
• FlowX.AI 4.7.7 Release Notes: Latest features, improvements, and bug fixes in our newest release
• Deployment guidelines v4.7.8
• FlowX.AI 4.7.8 Release Notes: Latest features, improvements, and bug fixes in our newest release
• Deployment guidelines v4.7.9
• FlowX.AI 4.7.9 Release Notes: Latest features, improvements, and bug fixes in our newest release
• Deployment guidelines v5.0.0
• Post-deployment configuration: This section contains the steps in the order we recommend for post-deployment configuration…
• Update environment variables: Update environment variables for all existing FlowX.AI services
• Install new services: Step-by-step installation guide for new FlowX.AI 5.0 services
• Overview: Complete migration guide from FlowX.AI 4.7.x to 5.0 with prerequisites and step-by-step proc…
• Prerequisites: This section contains the steps in the order we recommend for migrating data from FlowX v4.7…
• Renderer SDKs: This guide assists in migrating from FlowX.AI v4.7.x to v5.0.
• FlowX.AI 5.0.0 Release Notes: Latest features, improvements, and bug fixes in our newest release
• Deployment guidelines v5.1.1
• Deployment guidelines v5.1.2
• Deployment guidelines v5.1.3
• Deployment guidelines v5.1.4
• Deployment guidelines v5.1.5
• Deployment guidelines v5.1.6
• Deployment guidelines v5.1.7
• Deployment guidelines v5.1.8
• Deployment guidelines v5.1.9
• Deployment guidelines v5.1.0
• Post-deployment configuration: This section contains the steps in order that we recommend for post-deployment configuration…
• Update environment variables: Update environment variables for all existing FlowX.AI services
• Install new services: Step-by-step installation guide for new FlowX.AI 5.1.0 services
• Overview: Complete migration guide from FlowX.AI 4.7.x to 5.1.0 with prerequisites and step-by-step pr…
• Prerequisites: This section contains the steps in order that we recommend for migrating data from FlowX v4.…
• Renderer SDKs: This guide assists in migrating from FlowX.AI v4.7.x to v5.1.0.
• Post-upgrade troubleshooting: Common issues and solutions that may occur after upgrading from FlowX v4.7.x to v5.1.0.
• FlowX.AI 5.1.0 Release Notes: Introducing Workspaces, Project Data Model, Library-to-Library Dependencies, Data Mappers, R…
• FlowX.AI 5.1.1 Release Notes (LTS): WCAG 2.1 Level AA compliance achieved, AI Platform enhancements, bug fixes, and quality impr…
• FlowX.AI 5.1.2 Release Notes (LTS): Bug fixes, stability improvements, and quality enhancements for the FlowX.AI 5.1.x LTS line.
• FlowX.AI 5.1.3 Release Notes (LTS): Security patches, performance optimizations, bug fixes, and stability improvements for the F…
• FlowX.AI 5.1.4 Release Notes (LTS): Security patches, performance optimizations, bug fixes, and stability improvements for the F…
• FlowX.AI 5.1.5 Release Notes (LTS): Bug fixes and stability improvements for the FlowX.AI 5.1.x LTS line.
• FlowX.AI 5.1.6 Release Notes (LTS): Bug fixes, stability improvements, and platform enhancements for the FlowX.AI 5.1.x LTS line.
• FlowX.AI 5.1.7 Release Notes (LTS): Bug fixes and stability improvements for the FlowX.AI 5.1.x LTS line.
• FlowX.AI 5.1.8 Release Notes (LTS): Bug fixes and stability improvements for the FlowX.AI 5.1.x LTS line.
• FlowX.AI 5.1.9 Release Notes (LTS): Bug fixes and stability improvements for the FlowX.AI 5.1.x LTS line.
• Deployment guidelines v5.2.0
• Update environment variables: Update environment variables for all existing FlowX.AI services
• FlowX.AI 5.2.0 Release Notes: Accessibility improvements, new side panel navigation, FlowX Database sensitive data handlin…
• Deployment guidelines v5.3.0
• Overview: Migration guide for upgrading from FlowX.AI v5.2.0 to v5.3.0
• Update environment variables: Update environment variables for all existing FlowX.AI services
• FlowX.AI 5.3.0 Release Notes: UI Flows for multi-platform app building, UI Events for real-time interactions, enhanced cus…
• Deployment guidelines v5.4.0
• FlowX.AI 5.4.0 Release Notes: SaaS multi-tenant platform capabilities, database tenant isolation, email-triggered processe…
• Deployment guidelines v5.5.0
• Overview: Migration guide for upgrading from FlowX.AI v5.4.0 to v5.5.0
• Update environment variables: Environment variable changes when upgrading from FlowX.AI v5.4.0 to v5.5.0
• FlowX.AI 5.5.0 Release Notes: Enhanced Chat component, UI Flows improvements, Microsoft Outlook integration, container app…
• Deployment guidelines v5.6.0
• FlowX.AI 5.6.0 Release Notes: Conversational AI with memory and intent routing, incoming webhooks, proxy connections, unma…
• Deployment guidelines v5.7.0: Component versions, environment variables, and configuration changes for FlowX.AI 5.7.0 depl…
• FlowX.AI 5.7.0 Release Notes: Single-org on-premises deployment, custom React components, AI providers self-service, chat-…
• Deployment guidelines v5.8.0: Component versions, environment variables, and configuration changes for FlowX.AI 5.8.0 depl…
• FlowX.AI 5.8.0 Release Notes: Runtime authorization overhaul, UI Flow permissions, Custom Components in Processes, new the…
• Deployment guidelines v5.9.0: Component versions, environment variables, and configuration changes for FlowX.AI 5.9.0 depl…
• FlowX.AI 5.9.0 Release Notes: First LTS in the 5.9.x family. Brings conversational AI, UI Flows and Custom Components, AI…

OpenAPI Specs

• openapi