# KaireonAI

## Docs

- [Admin](https://docs.kaireonai.com/api-reference/admin.md): Platform administration endpoints for cache management, dead letter queue, retention policies, data cleanup, metrics, and tenant reset.
- [Row-Level Security](https://docs.kaireonai.com/api-reference/admin-rls.md): Check and enable PostgreSQL Row-Level Security (RLS) for tenant data isolation across all platform tables.
- [AI](https://docs.kaireonai.com/api-reference/ai.md): AI-powered analysis, chat assistant, natural language rule parsing, intelligence tools, and recommendation management. Supports LLM and ML Worker backends.
- [AI Parse Transform](https://docs.kaireonai.com/api-reference/ai-parse-transform.md): Convert natural language transform descriptions into structured pipeline transform nodes using LLM-powered parsing.
- [Alerts](https://docs.kaireonai.com/api-reference/alerts.md): Configure metric-based alert rules that fire notifications to configured Slack, Teams, webhook, or ops-email destinations when thresholds are breached.
- [Algorithm Models](https://docs.kaireonai.com/api-reference/algorithm-models.md): Manage scoring models (scorecard, bayesian, gradient_boosted, thompson_bandit, epsilon_greedy, neural_cf, online_learner). Train from real outcomes, score customers, score offer sets, upgrade model tiers, reset learning, and view evolution history.
- [API Keys](https://docs.kaireonai.com/api-reference/api-keys.md): Generate, list, and revoke API keys for programmatic access.
- [Approvals](https://docs.kaireonai.com/api-reference/approvals.md): Enterprise governance approval workflow for production changes. Supports submit, approve, and reject flows with automatic entity application on approval.
- [Portfolio Optimization Profiles API](https://docs.kaireonai.com/api-reference/arbitration-profiles.md): Create, update, list, and delete portfolio optimization profiles that define multi-objective scoring weights.
- [Attribution](https://docs.kaireonai.com/api-reference/attribution.md): Compute and query multi-touch attribution for customer conversions.
- [Audit Export](https://docs.kaireonai.com/api-reference/audit-export.md): Export audit logs for compliance and verify audit chain integrity.
- [Audit Logs](https://docs.kaireonai.com/api-reference/audit-logs.md): Immutable audit trail with SHA-256 integrity chain. Query logs, verify chain integrity, and export for SOC 2 compliance.
- [Authentication](https://docs.kaireonai.com/api-reference/auth.md): User registration, email verification, MFA (TOTP + backup codes), API key management, and SSO configuration (SAML/OIDC).
- [Behavioral Metrics](https://docs.kaireonai.com/api-reference/behavioral-metrics.md): Define and compute custom behavioral metrics with configurable aggregation functions, time windows, and batch or realtime compute modes.
- [Budget Forecast](https://docs.kaireonai.com/api-reference/budget-forecast.md): Project budget exhaustion dates based on historical conversion rates and spend patterns.
- [Budgets](https://docs.kaireonai.com/api-reference/budgets.md): Manage budget allocations for offers, categories, and channels.
- [Capture & Attribution](https://docs.kaireonai.com/api-reference/capture.md): Record customer events and attribute outcomes to decisions.
- [Categories API](https://docs.kaireonai.com/api-reference/categories.md): Create, update, list, and delete categories and sub-categories in the business hierarchy.
- [Change History](https://docs.kaireonai.com/api-reference/change-history.md): Query the audit log to see who changed what and when. Filterable by entity type, action, time range, and more.
- [Channels API](https://docs.kaireonai.com/api-reference/channels.md): Create, update, list, and delete delivery channels with placements.
- [Cleanup](https://docs.kaireonai.com/api-reference/cleanup.md): Trigger data cleanup operations for expired records and old audit logs.
- [CLV API](https://docs.kaireonai.com/api-reference/clv.md): Compute, retrieve, and batch-process Customer Lifetime Value scores using RFM analysis.
- [CMS Webhooks](https://docs.kaireonai.com/api-reference/cms-webhooks.md): Receive content update webhooks from external CMS providers.
- [Connectors](https://docs.kaireonai.com/api-reference/connectors.md): Manage external data source connections. 24 connector types are registered; 17 are production-ready and 7 are marked coming-soon (UI forms exist, pipeline ingestion not yet wired).
- [Contact Policies API](https://docs.kaireonai.com/api-reference/contact-policies.md): Create, update, list, and delete contact policies that govern communication frequency and suppression.
- [Content](https://docs.kaireonai.com/api-reference/content.md): Manage content items through a full lifecycle: draft, submit for review, approve, publish, reject, and revert to previous versions.
- [Content Sources](https://docs.kaireonai.com/api-reference/content-sources.md): Manage external CMS integrations for syncing content into KaireonAI.
- [Creatives API](https://docs.kaireonai.com/api-reference/creatives.md): Create, update, list, and delete creatives (treatments) linked to offers and channels.
- [Cron Jobs](https://docs.kaireonai.com/api-reference/cron.md): System-only scheduled maintenance and automation endpoints. Secured with CRON_SECRET / CRON_TOKEN. Intended caller is AWS EventBridge or an equivalent external scheduler.
- [Customers](https://docs.kaireonai.com/api-reference/customers.md): Customer profile, eligibility, simulation, suppressions, summaries, and GDPR-compliant data deletion endpoints.
- [Dashboard Data](https://docs.kaireonai.com/api-reference/dashboard-data.md): Aggregated data endpoints powering the platform dashboards.
- [Data Sources API](https://docs.kaireonai.com/api-reference/data-sources.md): Create, update, list, and delete data source configurations for ingesting external data.
- [Decision Flow Internals](https://docs.kaireonai.com/api-reference/decision-flow-internals.md): Assembly log, base flow creation, and internal decision flow management endpoints.
- [Decision Flow Rollback](https://docs.kaireonai.com/api-reference/decision-flow-rollback.md): Roll back a decision flow to a previously published version. Creates a new version with the restored configuration, preserving immutable history.
- [Decision Flow Versions](https://docs.kaireonai.com/api-reference/decision-flow-versions.md): Retrieve the published version history of a decision flow, or fetch the full configuration snapshot for a specific version.
- [Decision Flows API](https://docs.kaireonai.com/api-reference/decision-flows.md): Create, update, publish, and delete Decision Flows — the core decisioning pipelines.
- [Decision Traces](https://docs.kaireonai.com/api-reference/decision-traces.md): Query forensic decision traces that capture the full pipeline execution for each Recommend API call. Traces record qualification, scoring, ranking, and arbitration steps.
- [DSAR (Data Subject Access Requests)](https://docs.kaireonai.com/api-reference/dsar.md): GDPR/CCPA data subject access request management — export or delete customer data.
- [Events](https://docs.kaireonai.com/api-reference/events.md): Ingest customer events for real-time trigger evaluation and stream processing.
- [Event Ingestion API](https://docs.kaireonai.com/api-reference/events-ingest.md): Ingest real-time customer events that trigger actions, journey enrollments, and cross-channel workflows.
- [Experiments](https://docs.kaireonai.com/api-reference/experiments.md): Create champion/challenger experiments with traffic splitting, holdout groups, and statistical uplift analysis using two-proportion z-tests.
- [Export & Import](https://docs.kaireonai.com/api-reference/export-import.md): Export full tenant configuration and import it into another environment.
- [Extensions](https://docs.kaireonai.com/api-reference/extensions.md): Discover registered platform extensions and plugin points.
- [Flow Routes API](https://docs.kaireonai.com/api-reference/flow-routes.md): Create, update, list, and delete flow-to-placement routing rules that map channels and placements to decision flows.
- [GDPR Erasure](https://docs.kaireonai.com/api-reference/gdpr.md): Erase all personal data for a customer to comply with GDPR right to erasure (right to be forgotten).
- [GDPR Erasure](https://docs.kaireonai.com/api-reference/gdpr-erasure.md): Permanently erase all data for a specific customer across all interaction and decision tables. Implements the GDPR right to erasure (Article 17).
- [Geofences API](https://docs.kaireonai.com/api-reference/geofences.md): Create, manage, and check geofences for location-based decisioning triggers.
- [Guardrails](https://docs.kaireonai.com/api-reference/guardrails.md): Create and manage guardrail rules that enforce business constraints on decisions.
- [Identity Resolution](https://docs.kaireonai.com/api-reference/identity.md): Resolve, link, and merge customer identities across channels and systems.
- [Interaction History](https://docs.kaireonai.com/api-reference/interaction-history.md): Query customer interaction records with filtering by customer, offer, creative, and interaction type.
- [Interaction Store](https://docs.kaireonai.com/api-reference/interaction-store.md): Configure the backend storage engine for interaction history data.
- [Interaction Summary](https://docs.kaireonai.com/api-reference/interaction-summary.md): Aggregated interaction analytics grouped by offer, creative, channel, or customer.
- [API Introduction](https://docs.kaireonai.com/api-reference/introduction.md): Base URLs, authentication, common headers, pagination, error handling, and rate limiting for the KaireonAI REST API.
- [Journeys](https://docs.kaireonai.com/api-reference/journeys.md): Create and manage customer journeys with visual flow definitions, test mode simulation, and enrollment analytics.
- [Metrics Summary](https://docs.kaireonai.com/api-reference/metrics-summary.md): Prometheus-style platform metrics in JSON format for the operations dashboard.
- [Model Governance](https://docs.kaireonai.com/api-reference/model-governance.md): Model approval workflows, drift detection, and fairness parity checks.
- [Model Scoring & Reset](https://docs.kaireonai.com/api-reference/model-scoring.md): Score individual customers with a model, and reset learned model state for retraining.
- [Notifications](https://docs.kaireonai.com/api-reference/notifications.md): CRUD and test endpoints for notification destinations (Slack, Teams, outbound webhook, ops email).
- [OAuth 2.0](https://docs.kaireonai.com/api-reference/oauth.md): OAuth 2.0 client credentials flow for machine-to-machine API access.
- [Offers API](https://docs.kaireonai.com/api-reference/offers.md): Create, update, list, and delete offers (actions) in the KaireonAI platform.
- [Onboarding Progress](https://docs.kaireonai.com/api-reference/onboarding.md): Track and update user onboarding checklist progress.
- [Outcome Types API](https://docs.kaireonai.com/api-reference/outcome-types.md): Create, update, list, and delete outcome type definitions that classify customer interaction results.
- [Permissions](https://docs.kaireonai.com/api-reference/permissions.md): List available permissions and resolve effective permissions for the current user.
- [Pipeline Runs](https://docs.kaireonai.com/api-reference/pipeline-runs.md): Monitor pipeline execution progress, download validation errors, and retry failed runs with checkpoint support.
- [Pipelines](https://docs.kaireonai.com/api-reference/pipelines.md): Create and manage ETL pipelines with visual flow nodes and edges. Supports batch and micro-batch execution modes with configurable parallelism (streaming mode is a planned placeholder).
- [Placements API](https://docs.kaireonai.com/api-reference/placements.md): Create, update, list, and delete placement slot definitions that describe where offers are displayed.
- [Platform Settings](https://docs.kaireonai.com/api-reference/platform-settings.md): Manage global platform infrastructure settings — email, SMS, push credentials.
- [Policy Conflicts](https://docs.kaireonai.com/api-reference/policy-conflicts.md): Analyze contact policy configurations for conflicts, overlaps, contradictions, and priority ties.
- [Policy Impact Preview](https://docs.kaireonai.com/api-reference/policy-impact-preview.md): Preview the impact of a proposed contact policy before deployment by analyzing how many customers would be affected.
- [Policy Snapshots](https://docs.kaireonai.com/api-reference/policy-snapshots.md): Retrieve point-in-time policy configuration snapshots for forensic replay.
- [Power Calculator](https://docs.kaireonai.com/api-reference/power-calculator.md): Calculate required sample sizes and estimated durations for A/B experiments based on statistical power analysis.
- [Customer Profiles](https://docs.kaireonai.com/api-reference/profiles.md): Unified customer profile aggregating data from all schema tables.
- [Qualification Rules API](https://docs.kaireonai.com/api-reference/qualification-rules.md): Create, update, list, and delete qualification rules that filter offers during decisioning.
- [Reach Estimate](https://docs.kaireonai.com/api-reference/reach-estimate.md): Estimate how many customers qualify or are excluded by a proposed qualification rule, with field distribution statistics.
- [Recommend API](https://docs.kaireonai.com/api-reference/recommend.md): Get personalized next-best-action recommendations for a customer. Supports single-placement, multi-placement, and Decision Flow routing.
- [Reports API](https://docs.kaireonai.com/api-reference/reports.md): CRUD for report templates, schedules, runs, and artifact downloads.
- [Respond API](https://docs.kaireonai.com/api-reference/respond.md): Record customer interactions and outcomes (impressions, clicks, conversions) against delivered recommendations.
- [Restore](https://docs.kaireonai.com/api-reference/restore.md): Restore soft-deleted entities by clearing their deletedAt timestamp.
- [Campaigns API](https://docs.kaireonai.com/api-reference/runs.md): Create and manage batch campaigns with schedules, volume constraints, and file output configuration. Trigger and monitor individual campaign runs.
- [Schema Data & Stats](https://docs.kaireonai.com/api-reference/schema-data.md): Preview rows from schema tables, get field statistics, and upload CSV files for schema inference.
- [Schemas](https://docs.kaireonai.com/api-reference/schemas.md): Define entity schemas that create real PostgreSQL tables. Manage fields with DDL side effects (ALTER TABLE) for customer, account, and custom entity types.
- [SCIM v2 (User Provisioning)](https://docs.kaireonai.com/api-reference/scim.md): SCIM 2.0 compliant user provisioning for enterprise identity providers.
- [Seed Datasets API](https://docs.kaireonai.com/api-reference/seed-datasets.md): List available sample datasets and load them into the platform for testing and demonstration.
- [Segment Overlap](https://docs.kaireonai.com/api-reference/segment-overlap.md): Analyze customer overlap between multiple segments to identify redundancy and optimize targeting.
- [Segments](https://docs.kaireonai.com/api-reference/segments.md): Create and manage customer segments backed by PostgreSQL views. Segments support cross-schema joins and filter conditions for dynamic audience definition.
- [Settings](https://docs.kaireonai.com/api-reference/settings.md): View platform settings including database status and feature flags.
- [Simulate](https://docs.kaireonai.com/api-reference/simulate.md): Simulate a Recommend API call against a Decision Flow to preview results without recording outcomes or traces.
- [Single Sign-On (SSO)](https://docs.kaireonai.com/api-reference/sso.md): Configure and use SAML 2.0 and OpenID Connect SSO for enterprise authentication.
- [Starter Kits](https://docs.kaireonai.com/api-reference/starter-kits.md): Pre-built industry templates that seed your tenant with sample data, offers, Decision Flows, and rules.
- [Sub-Categories API](https://docs.kaireonai.com/api-reference/sub-categories.md): Create, update, list, and delete sub-categories within offer categories.
- [Summary Definitions](https://docs.kaireonai.com/api-reference/summary-definitions.md): CRUD endpoints for interaction summary aggregation shapes -- define how interaction data is bucketed and aggregated.
- [Templates](https://docs.kaireonai.com/api-reference/templates.md): Manage reusable content templates for creatives and communications.
- [Tenant Management](https://docs.kaireonai.com/api-reference/tenant.md): Tenant status checks and playground workspace reset.
- [Tenant Settings API](https://docs.kaireonai.com/api-reference/tenant-settings.md): Read and update tenant-level configuration including feature flags, thresholds, and integration settings.
- [Triggers](https://docs.kaireonai.com/api-reference/triggers.md): Define event-driven trigger rules that fire actions (journey enrollment, webhook, decision request) based on incoming event conditions.
- [Unified Customer Profile](https://docs.kaireonai.com/api-reference/unified-profile.md): Aggregated customer profile combining identities, interactions, journeys, experiments, and consent data into a single view.
- [Users API](https://docs.kaireonai.com/api-reference/users.md): List and invite users for tenant user management.
- [Waitlist](https://docs.kaireonai.com/api-reference/waitlist.md): Public waitlist signup endpoint for collecting interest before open-source launch.
- [Webhooks](https://docs.kaireonai.com/api-reference/webhooks.md): Webhook endpoints for receiving delivery status callbacks from external providers.
- [Why-Not API](https://docs.kaireonai.com/api-reference/why-not.md): Action analysis endpoint — explains exactly why an offer was or wasn't shown to a specific customer.
- [Engine Architecture](https://docs.kaireonai.com/architecture/engine.md): How the decisioning engine processes a Recommend API request end-to-end — from tenant authentication through pipeline execution to response assembly.
- [Operations Architecture](https://docs.kaireonai.com/architecture/operations.md): Monitoring, rate limiting, circuit breakers, and operational controls for KaireonAI.
- [Architecture Overview](https://docs.kaireonai.com/architecture/overview.md): System architecture, technology choices, and module structure of the KaireonAI platform.
- [Scaling & Performance](https://docs.kaireonai.com/architecture/scaling.md): How to scale KaireonAI for production workloads
- [Security Model](https://docs.kaireonai.com/architecture/security-model.md): Defense-in-depth security architecture — tenant isolation, authentication, SSRF protection, encryption, rate limiting, and audit logging.
- [Changelog](https://docs.kaireonai.com/changelog.md): Notable changes to the KaireonAI platform, in reverse chronological order. New capabilities land here when they are deployed to playground.kaireonai.com.
- [Core Concepts](https://docs.kaireonai.com/core-concepts.md): Understand the mental model behind KaireonAI — the key building blocks and how they fit together.
- [Cloud Deployment (AWS)](https://docs.kaireonai.com/deployment/cloud.md): Deploy KaireonAI to AWS App Runner with Supabase and Upstash for a fully managed production stack.
- [Cost & Performance Guide](https://docs.kaireonai.com/deployment/cost-performance.md): Deployment tier comparison with monthly costs, throughput estimates, and response time benchmarks for KaireonAI.
- [Optional: Enable Scheduled Automation](https://docs.kaireonai.com/deployment/eventbridge-setup.md): Wire AWS EventBridge to call /api/cron/tick so alert rules evaluate automatically and scheduled reports run without manual intervention. Optional during pilot — everything works on-demand without it.
- [Helm Chart Reference](https://docs.kaireonai.com/deployment/helm-reference.md): Deploy KaireonAI to Kubernetes with Helm — chart values, deployment modes, monitoring, and network policies.
- [Infrastructure Backends](https://docs.kaireonai.com/deployment/infrastructure-backends.md): Pluggable backend adapters for interaction storage, event bus, search, caching, and logging — choose the right stack for your scale.
- [Kubernetes (Helm)](https://docs.kaireonai.com/deployment/kubernetes.md): Deploy KaireonAI to any Kubernetes cluster using the provided Helm chart for full infrastructure control.
- [Local Development](https://docs.kaireonai.com/deployment/local.md): Run KaireonAI on your local machine for development and evaluation.
- [ML Worker Setup](https://docs.kaireonai.com/deployment/ml-worker.md): Deploy the Python ML Worker for scikit-learn analysis.
- [Installation Options](https://docs.kaireonai.com/deployment/options.md): Choose the deployment method that fits your infrastructure — local development, cloud-managed, or self-hosted Kubernetes.
- [AI Workflows](https://docs.kaireonai.com/guides/ai-workflows.md): Common workflows using KaireonAI's AI assistant and MCP tools
- [Computed Values](https://docs.kaireonai.com/guides/computed-values.md): Define formula-based fields that are evaluated per customer at decision time.
- [Starbucks Dataset Guide](https://docs.kaireonai.com/guides/datasets/starbucks.md): End-to-end walkthrough of the Starbucks rewards dataset — the most complete dataset pack with 10 offers, 6 channels, qualification rules, contact policies, and 3 model types.
- [First scheduled report](https://docs.kaireonai.com/guides/first-scheduled-report.md): End-to-end tutorial: create a template, preview it, schedule it, and receive the output.
- [Formula Reference](https://docs.kaireonai.com/guides/formula-reference.md): Complete reference for the KaireonAI formula engine used in computed fields on Categories and Decision Flows.
- [Industry Templates](https://docs.kaireonai.com/guides/industry-templates.md): Pre-built starter kits for Banking (BFSI), Retail, and Telecom -- get a working next-best-action setup in minutes.
- [MCP Quickstart](https://docs.kaireonai.com/guides/mcp-quickstart.md): Connect your AI IDE to KaireonAI in 5 minutes
- [Sample Data](https://docs.kaireonai.com/guides/sample-data.md): Pre-built dataset to explore the platform without manual setup.
- [SDK Quickstart](https://docs.kaireonai.com/guides/sdk-quickstart.md): Integrate with the KaireonAI Recommend and Respond APIs from JavaScript or Python in minutes.
- [Self-Hosted LLM Setup](https://docs.kaireonai.com/guides/self-hosted-llm.md): Run KaireonAI's AI features with your own local or self-hosted language model — Ollama, vLLM, LM Studio, or any OpenAI-compatible API.
- [Share a Dashboard as a Report](https://docs.kaireonai.com/guides/sharing-a-dashboard.md): End-to-end walkthrough: open a dashboard, export as PDF, then convert the same view into a scheduled report delivered to Slack.
- [Tutorial: Starbucks Offers](https://docs.kaireonai.com/guides/starbucks-tutorial.md): Follow along as we build a complete next-best-action pipeline for Starbucks. Load data, explore offers, run recommendations, and watch models learn.
- [Troubleshooting](https://docs.kaireonai.com/guides/troubleshooting.md): Common issues and how to resolve them for self-hosted KaireonAI deployments
- [Try the AI Assistant](https://docs.kaireonai.com/guides/try-ai-assistant.md): Your first conversation with the KaireonAI AI assistant — guided examples with loaded sample data.
- [AI Assistant Integration](https://docs.kaireonai.com/integrations/ai-assistant.md): Built-in AI assistant with 105+ context-aware tools for building and managing your decisioning setup.
- [MCP Integration](https://docs.kaireonai.com/integrations/mcp.md): Connect KaireonAI to any AI IDE with 110 Model Context Protocol tools
- [Introduction](https://docs.kaireonai.com/introduction.md): KaireonAI is an open-source Next-Best-Action platform that decides what to recommend, to whom, through which channel — in real time.
- [Adaptive Learning](https://docs.kaireonai.com/platform/adaptive-learning.md): Per-offer self-learning propensity models that improve automatically with every customer interaction.
- [Agent Playbooks](https://docs.kaireonai.com/platform/agent-playbooks.md): Composable MCP playbooks that chain primitive tools into one-shot agent workflows
- [AI Assistant](https://docs.kaireonai.com/platform/ai-assistant.md): Build and manage your decisioning platform using natural language
- [AI Configuration](https://docs.kaireonai.com/platform/ai-configuration.md): Configure AI analyzer parameters for your organization.
- [Content Intelligence](https://docs.kaireonai.com/platform/ai-content-intelligence.md): Analyze creative performance and get AI-powered improvement suggestions.
- [AI Document Import](https://docs.kaireonai.com/platform/ai-document-import.md): Upload a brand deck or product spec to the AI chat panel; the LLM extracts offers, creatives, channels, audiences, and qualification rules with page citations. Operators review per row, then apply atomically.
- [AI Insights Dashboard](https://docs.kaireonai.com/platform/ai-insights.md): Proactive intelligence across your decisioning platform -- health checks, performance analysis, and policy conflict detection.
- [AI Pipeline Authoring](https://docs.kaireonai.com/platform/ai-pipeline-authoring.md): Author and edit Pipeline IR from natural-language prompts. Every AI proposal is schema-validated before you can apply it.
- [Smart Policy Recommender](https://docs.kaireonai.com/platform/ai-policy-recommender.md): AI-powered contact policy optimization based on interaction history.
- [Natural Language Rule Building](https://docs.kaireonai.com/platform/ai-rule-builder.md): Create qualification rules, contact policies, and behavioral metrics from natural language.
- [Auto-Segmentation](https://docs.kaireonai.com/platform/ai-segmentation.md): Discover customer segments from your data automatically.
- [Alert Rules](https://docs.kaireonai.com/platform/alert-rules.md): Define metric thresholds that fire notifications to configured destinations when breached, with cooldown support.
- [Algorithms & Models](https://docs.kaireonai.com/platform/algorithms.md): ML models that score offers for customers — from manual scorecards to neural collaborative filtering, with built-in experimentation.
- [Authentication](https://docs.kaireonai.com/platform/authentication.md): Sign up, sign in, and manage user access on the KaireonAI platform.
- [Behavioral Metrics](https://docs.kaireonai.com/platform/behavioral-metrics.md): Computed aggregations over interaction history -- use in contact policies, qualification rules, and scoring.
- [Business Hierarchy](https://docs.kaireonai.com/platform/business-hierarchy.md): Organize offers into categories and sub-categories with custom fields, including computed fields with formulas.
- [Channels](https://docs.kaireonai.com/platform/channels.md): Define delivery mechanisms for recommendations — email, push, SMS, in-app, web, WhatsApp, webhook, and direct mail.
- [Customer Lifetime Value (CLV)](https://docs.kaireonai.com/platform/clv.md): RFM-based CLV scoring that segments customers, predicts revenue, and estimates churn probability.
- [Compliance & Privacy](https://docs.kaireonai.com/platform/compliance.md): Data privacy, compliance, and audit features in KaireonAI.
- [Composable Pipeline](https://docs.kaireonai.com/platform/composable-pipeline.md): Build Decision Flows from modular node blocks arranged in a 3-phase pipeline.
- [Connector expansion — 22 new integrations](https://docs.kaireonai.com/platform/connectors-expanded.md): KaireonAI now ships 39 production-depth connector integrations — 17 original + 22 added via the connector-expansion release. Full HTTP / SDK implementations with dynamic UI form generation.
- [Contact Policies](https://docs.kaireonai.com/platform/contact-policies.md): Rules that suppress already-qualified Offers based on contact frequency, timing, budget, and cross-channel constraints.
- [Content Management](https://docs.kaireonai.com/platform/content-management.md): Manage content items with approval workflows, version history, and CMS integration for multi-channel delivery.
- [Creatives](https://docs.kaireonai.com/platform/creatives.md): Content variants that define how an offer is presented to a customer on a specific channel.
- [Dashboards](https://docs.kaireonai.com/platform/dashboards.md): Monitor platform health, business performance, data quality, model accuracy, and channel attribution from five purpose-built dashboards.
- [Data Platform](https://docs.kaireonai.com/platform/data.md): Connect to data sources, define entity schemas, and build visual ETL pipelines.
- [Decision Flows](https://docs.kaireonai.com/platform/decision-flows.md): The orchestration layer that turns a Recommend API request into ranked, personalized offers.
- [Decisioning Gates](https://docs.kaireonai.com/platform/decisioning-gates.md): Three-stage rule pipeline — Eligibility, Fit Filters, Match Scoring — that decides which offers reach each customer.
- [Executive Dashboard](https://docs.kaireonai.com/platform/executive-dashboard.md): C-suite-ready view combining LLM-narrated weekly summary, KPI deltas, anomaly feed, segment × offer heatmap, and one-click Save-as-Scheduled-Report.
- [LLM Explanations](https://docs.kaireonai.com/platform/explanations.md): On-demand natural-language explanations of individual decisions, generated by your configured LLM provider. Three modes (regulator, agent, customer), PII-redacted inputs, cached per trace, opt-in per tenant.
- [Fairness + Drift Monitoring](https://docs.kaireonai.com/platform/fairness-drift.md): Demographic-parity + four-fifths-rule + equalized-odds fairness evaluation, plus PSI + KS drift detection endpoints. EU AI Act Art. 10 § 2(f)-ready.
- [File Ingestion (Flow)](https://docs.kaireonai.com/platform/file-ingestion.md): How KaireonAI Flow discovers, stages, parses, and archives source files. Pattern matching with date templates, latest-by-mtime ordering, atomic staging, wait policy with deadline-miss alerts.
- [Flow Editor UI](https://docs.kaireonai.com/platform/flow-editor-ui.md): The 3-pane Flow editor at /data/flow-pipelines/[id]/edit — visual canvas, JSON IR editor, SQL preview, runs, lineage, errors, and schedule.
- [Flow Error Inspector](https://docs.kaireonai.com/platform/flow-error-inspector.md): Failure summary + DLQ row sample + Fix-with-AI loop for the latest failed pipeline run.
- [Flow Getting Started](https://docs.kaireonai.com/platform/flow-getting-started.md): 5 steps to build, run, and observe your first IR-native Flow pipeline.
- [Flow Lineage](https://docs.kaireonai.com/platform/flow-lineage.md): Walk back from any target row to the IR source node + run that produced it. Reads the _kaireon_lineage JSONB column written by every target executor.
- [Flow Overview & Audit Readiness](https://docs.kaireonai.com/platform/flow-overview.md): What KaireonAI Flow ships today, how the pieces connect, and the honest residuals waiting on infrastructure.
- [Flow Schedule](https://docs.kaireonai.com/platform/flow-schedule.md): Visual cron / interval / RRule builder for ir.schedule. Schedules are stored on the IR but do not fire until Phase 6.5 (cron scheduler service) ships.
- [Flow Scheduler](https://docs.kaireonai.com/platform/flow-scheduler.md): GET /api/v1/cron/flow-scheduler-tick — invokes due pipelines from their ir.schedule. Shipped in Phase 6.5; closes the loop on Phase 6.3's schedule UI.
- [Geofencing & Location Triggers](https://docs.kaireonai.com/platform/geofencing.md): Define geographic boundaries and trigger real-time actions when customers enter, exit, or dwell in a location.
- [Glossary](https://docs.kaireonai.com/platform/glossary.md): Canonical terminology for the KaireonAI platform. All documentation uses these terms consistently.
- [Industry Accelerators](https://docs.kaireonai.com/platform/industry-accelerators.md): Drop-in decisioning packs for Banking, Telco, and Retail — full categories, offers, qualification rules, decision flows, and creatives seeded into your tenant in one click.
- [Journeys](https://docs.kaireonai.com/platform/journeys.md): Multi-step customer engagement workflows with a visual flow editor for orchestrating decisions over time.
- [Open-Source Model](https://docs.kaireonai.com/platform/licensing.md): KaireonAI is fully open-source — all features are available to everyone with no tiers, no license keys, and no feature restrictions.
- [Loading Modes, Hooks & Validation](https://docs.kaireonai.com/platform/loading-modes-validation.md): Six target load modes, four hook types, four dataset validators, in-memory row-level rule enforcement, and per-pipeline DLQ tables.
- [MCP Flow Server](https://docs.kaireonai.com/platform/mcp-flow-server.md): Operate the KaireonAI decisioning + pipeline platform from any MCP-aware AI assistant — Claude Desktop, Cursor, downstream agents.
- [Notification Destinations](https://docs.kaireonai.com/platform/notifications.md): Configure Slack, Teams, outbound webhook, and ops-email destinations that receive operational notifications like alert fires and scheduled reports.
- [Offers](https://docs.kaireonai.com/platform/offers.md): The core decisioning unit — define what you can recommend to customers with priority, budget, scheduling, and qualification controls.
- [Live Console](https://docs.kaireonai.com/platform/ops-manager.md): Real-time monitoring console for decisioning operations — live metrics, customer diagnostics, and action analysis.
- [Capacity Planning](https://docs.kaireonai.com/platform/ops/capacity-planning.md): Resource sizing, throughput estimates, and scaling guidelines for KaireonAI deployments
- [Configuration Reference](https://docs.kaireonai.com/platform/ops/configuration-reference.md): Complete reference for all KaireonAI environment variables and configuration options
- [Installation Guide](https://docs.kaireonai.com/platform/ops/installation-guide.md): Step-by-step guide for installing KaireonAI in production environments
- [Disaster Recovery](https://docs.kaireonai.com/platform/ops/runbooks/disaster-recovery.md): Runbook for KaireonAI disaster recovery — backup verification, failover, data restore
- [Scaling](https://docs.kaireonai.com/platform/ops/runbooks/scaling.md): Runbook for scaling KaireonAI — horizontal scaling, database scaling, cache sizing
- [Security Hardening](https://docs.kaireonai.com/platform/ops/security-hardening.md): Production security checklist and hardening guide for KaireonAI
- [SLA & SLO](https://docs.kaireonai.com/platform/ops/sla-slo.md): Service level agreements, objectives, and monitoring for KaireonAI deployments
- [Outcome Types](https://docs.kaireonai.com/platform/outcome-types.md): Define the vocabulary of customer interactions — impressions, clicks, conversions, complaints, and custom outcomes.
- [Pipeline IR (Flow)](https://docs.kaireonai.com/platform/pipeline-ir.md): The typed JSON-AST format that defines every KaireonAI Flow pipeline. Authored by humans or AI; validated before it can run.
- [Pre-Deployment Intelligence](https://docs.kaireonai.com/platform/pre-deployment-intelligence.md): Five APIs that let you preview the impact of configuration changes before they go live — policy impact, qualification reach, budget burn, experiment power, and segment overlap.
- [Qualification Rules](https://docs.kaireonai.com/platform/qualification-rules.md): Rules that determine whether an Offer is eligible for a given customer, evaluated during the Filter stage of a Decision Flow.
- [Report schedules](https://docs.kaireonai.com/platform/report-schedules.md): Bind templates to cron cadences and notification destinations so reports run automatically — when the cron is wired. Without the cron, schedules still define nextRunAt but don't fire; use Run Now or /run-now API for on-demand delivery.
- [Report templates](https://docs.kaireonai.com/platform/report-templates.md): Structure, fields, and configuration options for the ReportTemplate model.
- [Reports](https://docs.kaireonai.com/platform/reports.md): Compose, preview, schedule, and deliver LLM-narrated reports to any configured notification destination.
- [Retention & Archival](https://docs.kaireonai.com/platform/retention.md): Configure data retention periods, automated cleanup, and Hive-structured exports for interaction history and summaries.
- [Campaigns (Batch Execution)](https://docs.kaireonai.com/platform/runs.md): Schedule recurring batch campaigns against target segments with volume constraints, file output configuration, and full execution history.
- [Security](https://docs.kaireonai.com/platform/security.md): Defense-in-depth security architecture in KaireonAI: encryption, tenant isolation, authentication, authorization, audit logging, and compliance.
- [Exact SHAP explainability](https://docs.kaireonai.com/platform/shap.md): TreeSHAP for gradient_boosted + KernelSHAP for neural_cf — per-feature Shapley contributions with audit-verified additivity, baked into /recommend hot path when opted in.
- [Flow Streaming Runtime](https://docs.kaireonai.com/platform/streaming-runtime.md): Long-running consumer process for Kafka / Kinesis / Pulsar with at-least-once delivery + checkpoint persistence + Debezium-backed cdc_mirror. Gated behind FLOW_STREAMING_ENABLED for self-hosted deployments.
- [Decisioning Studio](https://docs.kaireonai.com/platform/studio.md): Create and manage offers, channels, qualification rules, contact policies, and Decision Flows.
- [Summary Definitions](https://docs.kaireonai.com/platform/summary-definitions.md): User-configurable aggregation shapes that control how interaction data is rolled up for contact policies, dashboards, and analytics.
- [Triggers](https://docs.kaireonai.com/platform/triggers.md): Event-driven automation that fires actions in response to customer events and data changes.
- [Action Analysis (Why-Not)](https://docs.kaireonai.com/platform/why-not-analysis.md): Understand exactly why a specific offer was or wasn't shown to a customer — full decision transparency.
- [YAML Connectors & Plugin SDK](https://docs.kaireonai.com/platform/yaml-connectors.md): Declarative HTTP connectors via YAML; engineer-authored plugins via the typed SDK; AI-generated drafts (coming in Phase 5b).
- [Quickstart](https://docs.kaireonai.com/quickstart.md): Get KaireonAI running and make your first recommendation in under 10 minutes.
- [Roadmap](https://docs.kaireonai.com/roadmap.md): Forward-looking view of what's actively being worked on, what's queued, and what's intentionally deferred. Not a contract — priorities shift as we learn from pilot deployments.

## OpenAPI Specs

- [openapi](https://docs.kaireonai.com/api-reference/openapi.json)