Documentation Index
Fetch the complete documentation index at: https://docs.flowx.ai/llms.txt
Use this file to discover all available pages before exploring further.
Overview
The AI Platform consists of three layers:- Java services — Core platform services handling data, orchestration, and storage (gRPC + GraphQL)
- Python services — AI agent services for code generation, analysis, design, and knowledge processing (REST + gRPC)
- Event-driven workers — Background services consuming Kafka topics for indexing and tenant replication
Infrastructure requirements
Qdrant
Vector database for embeddings. Cluster mode recommended for production.
S3-compatible storage
Object storage for binaries and files. Any S3-compatible provider works (MinIO, AWS S3, etc.).
Kafka
Message broker for event-driven communication. KRaft mode supported.
Keycloak
Identity provider for OAuth2 authentication across all services.
SpiceDB
Fine-grained authorization system for access control.
Service architecture
The AI Platform is a set of Python services. In Kubernetes, every service listens on port 9100 (set via theSERVICE_PORT variable).
| Service (Kubernetes name) | Protocol | Purpose |
|---|---|---|
ai-platform-planner | gRPC | Generates execution plans from user prompts (intent understanding and orchestration) |
ai-platform-agent-builder | gRPC | Configuration and runtime for low-code AI nodes |
ai-platform-knowledgebase-rag | gRPC | Retrieval-augmented generation over the knowledge base |
ai-platform-embedder | gRPC | Embedding generation (also consumes durable embedding jobs from Kafka) |
ai-platform-knowledgebase-indexer-v2 | Kafka worker | Generates retrieval vectors; event-driven, consumes the knowledge-base index-request topic |
ai-platform-ai-analyst | HTTP | Process-design expertise (config-time agent) |
ai-platform-ai-assistant | HTTP | FlowX.AI documentation assistant |
ai-platform-ai-designer | HTTP | UI design and implementation expertise (config-time agent) |
ai-platform-ai-developer | HTTP | Coding expertise (config-time agent) |
The Designer AI chat surface routes through the
ai-gateway service (part of the core services), which calls ai-platform-planner and the agent services. The evals-judge worker, deployed alongside the AI Platform, consumes ai.flowx.ai-platform.evals-judge.job.request.v1 for evaluations.Environment variables
- Service discovery
- Authentication
- Infrastructure
- AI models
- Observability
- Service endpoints
These variables control how services locate each other within the cluster:
Kubernetes deployment:Docker Compose / local deployment:
| Environment Variable | Description | Default Value |
|---|---|---|
GRPC_HOST_RESOLVER | Service discovery method | k8s |
GRPC_HOST_RESOLVER_HELM_CHART | Helm chart name for K8s service resolution | — |
GRPC_HOST_RESOLVER_FIXED_IP | Fixed IP/hostname when using host resolver | ai-platform |
SERVICE_PORT | Port the service listens on | 9100 (production) |
Agent Builder configuration
| Environment Variable | Description | Default Value |
|---|---|---|
AGENT_BUILDER_MAX_TOOL_CALLS | Maximum number of tool calls an agent can make in a single workflow execution | 20 |
Kafka topics
The AI Platform uses the following internal Kafka topics:| Topic | Partitions | Purpose |
|---|---|---|
ai.flowx.ai-platform.knowledgebase.store-entry.index-request.v1 | 1 | Indexing requests consumed by Knowledgebase Indexer v2 |
ai.flowx.ai-platform.knowledgebase.store-entry.index-response.v1 | 1 | Indexing results produced by Knowledgebase Indexer v2 |
ai.flowx.ai-platform.evals-judge.job.request.v1 | 3 | Judge job requests from integration-designer to evals-judge |
ai.flowx.ai-platform.evals-judge.job.response.v1 | 3 | Scored responses from evals-judge back to integration-designer |
ai.flowx.ai-platform.evals-judge.job.dlq.v1 | 3 | Dead-letter queue for unscored judge jobs (manual operator review) |
For production environments, create these topics manually with appropriate replication factors. For development, Kafka auto-topic creation handles them automatically.
Deployment
- Kubernetes (Helm)
- Docker Compose
The AI Platform ships as an umbrella Helm chart aggregating all microservices and infrastructure dependencies.Install or upgrade:After deployment, initialize the platform:
Global configuration:
Key Helm values
Replica counts:| Service | Default Replicas |
|---|---|
| Planner | 2 |
| AI Developer | 2 |
| AI Analyst | 2 |
| AI Designer | 2 |
| Agent Builder | 2 |
| Knowledgebase RAG | 2 |
| Embedder | 2 |
Storage requirements
| Component | Default Persistent Volume | Notes |
|---|---|---|
| Qdrant data | 30Gi | Vector embeddings |
| Qdrant snapshots | 30Gi | Backup snapshots |
| MinIO | Distributed across 4 nodes | Configured per deployment |
| Kafka | 1Gi minimum | Adjust based on message volume |
Troubleshooting
Service discovery issues
Service discovery issues
Kubernetes DNS resolution:Common causes:
- Incorrect
GRPC_HOST_RESOLVER_HELM_CHARTvalue - Services not in the same namespace
- DNS not resolving due to CoreDNS issues
Database connectivity
Database connectivity
Qdrant health check:Common causes:
- Missing
QDRANT_CONNECTION_API_KEY - Qdrant cluster not fully initialized
Kafka connectivity
Kafka connectivity
Verify broker availability:Verify topics exist:Common causes:
- Wrong
KAFKA_BOOTSTRAP_SERVERSaddress - Topics not auto-created and not manually provisioned
- Security mode mismatch (
KAFKA_SECURITY_MODE)
Authentication problems
Authentication problems
Verify Keycloak connectivity:Common causes:
- Incorrect
SECURITY_OAUTH2_BASE_SERVER_URL - Realm name mismatch
- Client ID not registered in Keycloak
- SpiceDB token expired or misconfigured
AI model configuration errors
AI model configuration errors
If AI nodes fail with model-related errors:
- Verify that an AI provider is configured at Organization Settings → AI Settings → Model Providers with a successful connection test
- Check that models are enabled in the provider’s whitelist
- Verify that workspace-type model assignments are set for the relevant AI capability (text generation, image understanding, embeddings, document/OCR) under AI Settings → Defaults & Fallbacks
- Ensure
FLOWX_LIB_SECURITY_ORGANIZATION_MANAGER_BASE_URLis set on all Python AI services and points to a reachable Organization Manager instance
Related resources
AI in FlowX
Overview of config-time and business AI agents
Agent Builder
Build custom AI agents with the no-code agent builder
Deployment guidelines v5.9
Component versions and upgrade instructions

