# Mindbricks Documentation ## Documentation - [Welcome](https://docs.mindbricks.com/introduction.md): From Concept to Cloud: AI-Powered Backends with Zero Entropy - [Mindbricks Saas Guide](https://docs.mindbricks.com/mindbricks-saas.md): A Human-Readable Guide to the Mindbricks Platform UI with SaaS-Focused Explanations. - [Mindbricks GUI Guide](https://docs.mindbricks.com/mindbricks-gui-guide.md): A Human-Readable Guide to the Mindbricks Platform UI with Pattern-Aware Explanations. - [Mindbricks Project Introduction](https://docs.mindbricks.com/start-building.md): A Mindbricks Project is more than a configuration file—it's a living architectural blueprint that both humans and AI agents collaborate on. - [Understanding Authentication And Authorization in Mindbricks](https://docs.mindbricks.com/authentication-and-authorization.md): Mindbricks is an AI-powered, pattern-based backend microservice code generator. This document aims to guide human or AI architects* in designing applications on Mindbricks with authentication and authorization capabilities. It is recommended to read this document alongside the Mindbricks Pattern documentation, especially for the referenced patterns. - [Building a Service in Mindbricks](https://docs.mindbricks.com/build-your-service.md): Mindbricks is an AI-powered, pattern-driven platform for generating and deploying microservice-based backends. This document serves as a practical guide for both human architects and AI agents in designing robust microservices using the Mindbricks Service pattern. - [Designing Your Data Model In Mindbricks](https://docs.mindbricks.com/build-your-data-model.md): Data modeling is the foundation of every successful application in Mindbricks. At its core, a data model represents your business domain as structured, semantic entities that flow through your entire architecture. In Mindbricks, data models aren't just database schemas—they're intelligent patterns that define how information is stored, validated, accessed, and transformed across your microservices. - [Building Your API in Mindbricks](https://docs.mindbricks.com/build-your-api.md): No description found - [Using Actions and Workflows in Mindbricks APIs](https://docs.mindbricks.com/actions-and-workflow.md): Mindbricks treats every Business API as a workflow: a fixed chain of lifecycle milestones with optional actions that run after each milestone. Even with zero extra config, an API executes rich default behavior derived from its Data Object and CRUD type. Configurations (clauses/options) shape that behavior; actions let you extend it precisely where needed. - [Bulk CRUD Operations in Mindbricks](https://docs.mindbricks.com/bulk-crud-actions.md): Guide to handling bulk create, update, and delete operations using actions and job object strategy - [Building Applications with AI in Mindbricks](https://docs.mindbricks.com/using-ai-to-design-an-app.md): No description found - [Preview Your App](https://docs.mindbricks.com/preview-your-app.md): Test and explore your application and generated APIs in a temporary preview environment before deploying to staging or production. - [Create Your Infrastructure](https://docs.mindbricks.com/create-your-infrastructure.md): Set up and manage cloud servers that provide the persistent runtime environment required to deploy your application to staging or production. - [One-Click Deployment](https://docs.mindbricks.com/deploy-by-one-click.md): Deploy your fully designed backend to staging or production with a single action, monitor build progress, access live APIs, and track deployment history. - [Custom domain](https://docs.mindbricks.com/custom-domain.md): Comming soon.. - [Track Your Metrics](https://docs.mindbricks.com/track-your-metrics.md): Monitor real-time resource usage and service health across preview, staging, and production environments to ensure system stability and performance. - [Takeout Your Code](https://docs.mindbricks.com/teke-out-your-code.md): You can always takeout your code to your own Github/Gitlab account. You have this opportunity for backup strategies, to continue the development manually, to merge the Mindbricks generated services with your other applications or for manual deployment. - [Application MCP](https://docs.mindbricks.com/application-mcp.md): How generated Mindbricks projects expose Business APIs as MCP tools through the MCP-BFF aggregation layer, enabling AI agents to interact with your application backend. - [Using Integrations In Mindbricks](https://docs.mindbricks.com/using-integrations-in-mindbricks.md): Comming soon.. - [Google Gemini Integration](https://docs.mindbricks.com/google-gemini-integration.md): Comming soon.. - [Telegram Integration](https://docs.mindbricks.com/telegram-integration.md): Comming soon.. - [Amazon S3 Integration](https://docs.mindbricks.com/amazon-s3-integration.md): Comming soon.. - [Google Maps Integration](https://docs.mindbricks.com/google-maps-integration.md): Comming soon.. - [Writing Your Own Code in Mindbricks](https://docs.mindbricks.com/write-your-own-code.md): Most of your backend is defined through patterns (DataObject, BusinessApi, Service, ProjectAuthentication, etc.) and generated automatically. However, real-world systems always have edge cases—business rules, transformations, integrations, or performance hacks that can’t (and shouldn’t) be fully captured by declarative patterns alone. - [Database Utility Functions](https://docs.mindbricks.com/db-utility-functions.md): Comprehensive guide to the automatically generated database utility functions for each data object in your Mindbricks service. These functions provide a safe, consistent way to interact with your data while ensuring Elasticsearch synchronization and Kafka event publishing. - [MScript Cookbook](https://docs.mindbricks.com/mscript-cookbook.md): No description found - [Machine-to-Machine (M2M) Communication](https://docs.mindbricks.com/machine-to-machine-communication.md): Comprehensive guide to M2M authentication and authorization in Mindbricks, covering REST, gRPC, and Kafka communication patterns for secure inter-service communication. - [BFF Service & DataViews in Mindbricks](https://docs.mindbricks.com/bff-service.md): The BFF Service in Mindbricks is a specialized microservice that exists to answer a very specific question: Instead of forcing your UI to call many backend services and stitch results together, Mindbricks lets you define DataViews. - [MCP-BFF Service](https://docs.mindbricks.com/mcp-bff-service.md): Guide to the MCP-BFF service in Mindbricks: chat/tool orchestration, service documentation access, tenant-aware routing, and operational diagnostics. - [Mindbricks Notification Service](https://docs.mindbricks.com/notification-service.md): The Notification Service in Mindbricks is a system-generated microservice responsible for all email, SMS, push, WhatsApp, and in-app notification delivery across a Mindbricks application. - [Bucket Service](https://docs.mindbricks.com/bucket-service.md): Each mindbricks generated application has a bucket service used to store user files and other object-related files. - [Multi-Tenancy in Mindbricks](https://docs.mindbricks.com/mut-tennancy-guide.md): Mindbricks includes first-class, pattern-level support for multi-tenant architectures. Multi-tenancy enables a single deployed backend to securely serve multiple organizations, workspaces, clients, or accounts—called tenants—while maintaining strict isolation of data, authentication, access control, and workflows between them. - [Add Payment Workflows To Your Application](https://docs.mindbricks.com/payment-workflow.md): Mindbricks can handle payment flows as ordinary business logic using the business api actions with the payment gateway provider integrations, however since payment is a complicated flow which should be executed in a seamless cooperation of backend and frontend, Mindbricks provides native automatic integration with Stripe payment gateway. - [Build E-Commerce Shopping Carts](https://docs.mindbricks.com/shopping-cart-workflow.md): Mindbricks provides a comprehensive, auto-generated shopping cart system with Redis-first architecture for hyper-scalable cart management. Enable full e-commerce capabilities with a single configuration flag - cart management, promotions, coupons, checkout, and more. - [Geography Features](https://docs.mindbricks.com/geography-features.md): Comming soon.. - [GRPC Controllers](https://docs.mindbricks.com/grpc-controllers.md): Comming soon.. - [Cron Jobs](https://docs.mindbricks.com/cron-jobs.md): Comming soon.. - [Kafka Controllers](https://docs.mindbricks.com/kafka-controllers.md): Comming soon.. - [Realtime Service](https://docs.mindbricks.com/realtime-service.md): Master the Mindbricks Realtime Service: topic-based authorization, rights tokens, logic filters, public vs private topics, HTTP API, and Socket contract for secure realtime delivery. - [Realtime Hub Pattern](https://docs.mindbricks.com/realtime-hub.md): A comprehensive guide to designing bidirectional real-time communication hubs in Mindbricks. Covers Socket.IO rooms, typed messages, presence events, custom events, Kafka bridging, message persistence, room authorization, guardrails, and REST fallback endpoints. - [Supporting SSE in Business API Design](https://docs.mindbricks.com/sse-business-api.md): A comprehensive guide to Server-Sent Events (SSE) support in Mindbricks Business APIs. Covers streaming modes, stream sources, progress events, iterator actions, AI streaming, Kafka progress listeners, and SSE-aware workflow actions — all configured declaratively through patterns. - [AI Agents in Mindbricks](https://docs.mindbricks.com/ai-agents.md): A comprehensive guide to AI Agents in Mindbricks. Covers standalone AI Agent pattern design, provider configuration, execution modes, tool calling, conversation management, modalities, and the distinction between standalone agents, AiCallAction in Business APIs, and the MCP-BFF native agent. - [Genesis Project Management APIs](https://docs.mindbricks.com/genesis-project-management-apis.md): Practical guide for managing Mindbricks project JSON safely using Genesis APIs, including write lifecycles, validation-first workflows, editor tracking, and full project operations. - [Project Versioning & History](https://docs.mindbricks.com/project-versioning-and-history.md): How Mindbricks project JSON versioning works, including history queries, diff/compare, revert workflows, and conflict resolution guidance. - [Issues & Architect Docs](https://docs.mindbricks.com/project-issues-and-architect-docs.md): Collaboration guide for project issue tracking and architect documentation in Genesis, including status lifecycle, change linking, and practical team flow. - [Consuming Your Backend](https://docs.mindbricks.com/accessing-application-backend.md): This document includes a sample frontend guide prepared for a specific application designed, built and deployed in Mindbricks. The application name is TickatMe, and please note that any information referencing to tickatme should be considered as an example for your own project. - [Authentication Management](https://docs.mindbricks.com/authentication.md): This document includes a sample frontend guide for authetication management of a specific application designed, built and deployed in Mindbricks. The application name is TickatMe, and please note that any information referencing to **tickatme** should be considered as an example for your own project. - [Verification Management](https://docs.mindbricks.com/verification-services.md): This document includes a sample frontend guide for verification flow of a specific application designed, built and deployed in Mindbricks. The application name is TickatMe, and please note that any information referencing to tickatme should be considered as an example for your own project. - [Profile Management](https://docs.mindbricks.com/profile-management.md): This document includes a sample frontend guide for profile management of a specific application designed, built and deployed in Mindbricks. The application name is TickatMe, and please note that any information referencing to tickatme should be considered as an example for your own project. - [User Management](https://docs.mindbricks.com/user-management.md): This document includes a sample frontend guide for user management of a specific application designed, built and deployed in Mindbricks. The application name is TickatMe, and please note that any information referencing to tickatme should be considered as an example for your own project. - [Filter Parameters](https://docs.mindbricks.com/filter-parameters.md): Complete guide to filtering list APIs with query parameters, operators, and examples - [MCP in Mindbricks](https://docs.mindbricks.com/mcp-management.md): Overview of MCP integration in Mindbricks. This page has been split into two dedicated guides. - [Membership Pattern in Mindbricks](https://docs.mindbricks.com/how-to-use-share-tokens.md): Object-Level Membership & Membership Checks in Business APIs. The Membership pattern in Mindbricks is designed for domains where access to a resource is controlled by a membership relationship. - [Session & Session-Aware Business Logic in Mindbricks](https://docs.mindbricks.com/session-aware-logic.md): No description found - [Static Join on Properties](https://docs.mindbricks.com/static-joins.md): Materialized Joins for Denormalized, Read-Optimized Data. (PropertyStaticJoin) - [Indexing & Caching in Mindbricks](https://docs.mindbricks.com/index-patterns.md): How Mindbricks makes reads fast (and safe) across DB, Elasticsearch, and Redis. - [SelectJoin & PropertyRelation in Mindbricks](https://docs.mindbricks.com/select-join-pattern.md): Lightweight, relation-aware joins inside Get & List Business APIs. Mindbricks lets you connect DataObjects using Property Relations, then reuse those relations in many places (Business APIs, BFF DataViews, etc.). - [List Filters in ListOptions](https://docs.mindbricks.com/list-filters.md): Permission, Membership, Search & Joint Filters Without Joins. ListOptions in In addition to sorting, grouping, caching, and post-processing, ListOptions offer powerful filter features that let you filter the query with prefetched id lists. - [Mindbricks Project](https://docs.mindbricks.com/ontology/MindbricksProject.md): No description found - [Project Settings](https://docs.mindbricks.com/ontology/ProjectSettings.md): No description found - [Project Authentication](https://docs.mindbricks.com/ontology/ProjectAuthentication/ProjectAuthentication.md): No description found - [Auth Basics](https://docs.mindbricks.com/ontology/ProjectAuthentication/AuthBasics.md): No description found - [Login Definition](https://docs.mindbricks.com/ontology/ProjectAuthentication/LoginDefinition.md): No description found - [Verification Services](https://docs.mindbricks.com/ontology/ProjectAuthentication/VerificationServices.md): No description found - [Access Control](https://docs.mindbricks.com/ontology/ProjectAuthentication/AccessControl.md): No description found - [Social Login Settings](https://docs.mindbricks.com/ontology/ProjectAuthentication/SocialLoginSettings.md): No description found - [Data Property](https://docs.mindbricks.com/ontology/ProjectAuthentication/DataProperty.md): No description found - [BFF Service](https://docs.mindbricks.com/ontology/BFFService/BFFService.md): No description found - [Data View](https://docs.mindbricks.com/ontology/BFFService/DataView.md): No description found - [Notification Service](https://docs.mindbricks.com/ontology/NotificationService/NotificationService.md): No description found - [Notification Service Settings](https://docs.mindbricks.com/ontology/NotificationService/NotificationServiceSettings.md): No description found - [Event Notification](https://docs.mindbricks.com/ontology/NotificationService/EventNotification.md): No description found - [Service](https://docs.mindbricks.com/ontology/Service/Service.md): No description found - [Service Settings](https://docs.mindbricks.com/ontology/Service/ServiceSettings.md): No description found - [Data Object](https://docs.mindbricks.com/ontology/Service/DataObject.md): No description found - [Business Api](https://docs.mindbricks.com/ontology/Service/BusinessApi.md): No description found - [Service Library](https://docs.mindbricks.com/ontology/Service/ServiceLibrary.md): No description found - [Edge Controller](https://docs.mindbricks.com/ontology/Service/EdgeController.md): No description found - [Generated Assets Reference - Introduction](https://docs.mindbricks.com/generated-assets-reference/introduction.md): Introduction to Mindbricks generated assets and naming conventions. This guide explains how assets are named and organized, enabling architects to reference these assets in their business logic. - [General Service Assets](https://docs.mindbricks.com/generated-assets-reference/general-service-assets.md): Common assets generated for all services in Mindbricks, including session routes and general patterns that apply across all service types. - [Auth Service Generated Assets](https://docs.mindbricks.com/generated-assets-reference/auth-service-assets.md): Comprehensive reference for all automatically generated assets in the auth service, including data objects, Business APIs, REST routes, Kafka topics, and database utility functions. - [Payment Framework Generated Assets](https://docs.mindbricks.com/generated-assets-reference/payment-service-assets.md): Comprehensive reference for all automatically generated assets when StripeOrder pattern is enabled for data objects, including payment data objects, Business APIs, REST routes, Kafka topics, and system routes. - [BFF Service Generated Assets](https://docs.mindbricks.com/generated-assets-reference/bff-service-assets.md): Assets generated for Backend-for-Frontend (BFF) services in Mindbricks. This document covers BFF-specific data views, APIs, and routes. - [Notification Service Generated Assets](https://docs.mindbricks.com/generated-assets-reference/notification-service-assets.md): Assets generated for notification services in Mindbricks. This document covers notification-related data objects, Business APIs, and event handling. - [Bucket Service Generated Assets](https://docs.mindbricks.com/generated-assets-reference/bucket-service-assets.md): Assets generated for bucket (file storage) services in Mindbricks. This document covers file storage data objects, Business APIs, and file management routes. - [AddToContextAction](https://docs.mindbricks.com/references/actions/addtocontextaction.md): No description found - [AddToResponseAction](https://docs.mindbricks.com/references/actions/addtoresponseaction.md): No description found - [AiCallAction](https://docs.mindbricks.com/references/actions/aicallaction.md): Call an LLM (OpenAI, Anthropic, …) with a structured prompt to get text or JSON.Use it to generate labels, summaries, entity extraction, validation suggestions, or decision scaffolds used by later actions. - [ApiCallAction](https://docs.mindbricks.com/references/actions/apicallaction.md): No description found - [ArrowFunctionAction](https://docs.mindbricks.com/references/actions/arrowfunctionaction.md): No description found - [PaymentAction](https://docs.mindbricks.com/references/actions/paymentaction.md): No description found - [CollateListsAction](https://docs.mindbricks.com/references/actions/collatelistsaction.md): No description found - [CreateBucketTokenAction](https://docs.mindbricks.com/references/actions/createbuckettokenaction.md): No description found - [CreateCrudAction](https://docs.mindbricks.com/references/actions/createcrudaction.md): No description found - [CreateJWTTokenAction](https://docs.mindbricks.com/references/actions/createjwttokenaction.md): No description found - [CreateObjectAction](https://docs.mindbricks.com/references/actions/createobjectaction.md): No description found - [DataToFileAction](https://docs.mindbricks.com/references/actions/datatofileaction.md): No description found - [DeleteCrudAction](https://docs.mindbricks.com/references/actions/deletecrudaction.md): No description found - [FetchFromElasticAction](https://docs.mindbricks.com/references/actions/fetchfromelasticaction.md): Execute a raw Elasticsearch query for a data object and return normalized hits (items) and aggregations into context. - [FetchObjectAction](https://docs.mindbricks.com/references/actions/fetchobjectaction.md): No description found - [FetchParentAction](https://docs.mindbricks.com/references/actions/fetchparentaction.md): No description found - [FetchStatsAction](https://docs.mindbricks.com/references/actions/fetchstatsaction.md): No description found - [FunctionCallAction](https://docs.mindbricks.com/references/actions/functioncallaction.md): No description found - [IntegrationAction](https://docs.mindbricks.com/references/actions/integrationaction.md): No description found - [InterserviceCallAction](https://docs.mindbricks.com/references/actions/interservicecallaction.md): No description found - [ListMapAction](https://docs.mindbricks.com/references/actions/listmapaction.md): No description found - [LoopAction](https://docs.mindbricks.com/references/actions/loopaction.md): No description found - [MembershipCheckAction](https://docs.mindbricks.com/references/actions/membershipcheckaction.md): No description found - [ObjectPermissionCheckAction](https://docs.mindbricks.com/references/actions/objectpermissioncheckaction.md): No description found - [ParallelAction](https://docs.mindbricks.com/references/actions/parallelaction.md): No description found - [PermissionCheckAction](https://docs.mindbricks.com/references/actions/permissioncheckaction.md): No description found - [PublishEventAction](https://docs.mindbricks.com/references/actions/publisheventaction.md): No description found - [ReadFromRedisAction](https://docs.mindbricks.com/references/actions/readfromredisaction.md): No description found - [ReadJwtTokenAction](https://docs.mindbricks.com/references/actions/readjwttokenaction.md): No description found - [RedirectAction](https://docs.mindbricks.com/references/actions/redirectaction.md): No description found - [RefineByAiAction](https://docs.mindbricks.com/references/actions/refinebyaiaction.md): No description found - [RemoveFromResponseAction](https://docs.mindbricks.com/references/actions/removefromresponseaction.md): No description found - [RenderDataAction](https://docs.mindbricks.com/references/actions/renderdataaction.md): No description found - [SearchObjectAction](https://docs.mindbricks.com/references/actions/searchobjectaction.md): No description found - [SendMailAction](https://docs.mindbricks.com/references/actions/sendmailaction.md): No description found - [SendPushNotificationAction](https://docs.mindbricks.com/references/actions/sendpushnotificationaction.md): No description found - [SendSmsAction](https://docs.mindbricks.com/references/actions/sendsmsaction.md): No description found - [UpdateCrudAction](https://docs.mindbricks.com/references/actions/updatecrudaction.md): No description found - [ValidationAction](https://docs.mindbricks.com/references/actions/validationaction.md): No description found - [VerifyWebhookAction](https://docs.mindbricks.com/references/actions/verifywebhookaction.md): No description found - [WriteToRedisAction](https://docs.mindbricks.com/references/actions/writetoredisaction.md): No description found - [MScript Syntax Guide](https://docs.mindbricks.com/mscript-syntax.md): No description found - [MScript Query Operators Reference](https://docs.mindbricks.com/mscript-query-reference.md): Comprehensive reference for all MScript Query operators with their Sequelize, MongoDB, and Elasticsearch equivalents, including examples for each operator. ## Changelog - [Changelog](https://docs.mindbricks.com/changelog.md): Release history and updates for Mindbricks