Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.kaireonai.com/llms.txt

Use this file to discover all available pages before exploring further.

GET /api/v1/starter-kits

List available starter kits.

Response

Returns a flat JSON array (not wrapped in an object). Each item has id, name, description, and industry.
[
  {
    "id": "telecom",
    "name": "Telecom Cross-Sell",
    "description": "Complete setup for telecom cross-sell/upsell with offers, flows, and rules",
    "industry": "telecom"
  },
  {
    "id": "banking",
    "name": "Retail Banking",
    "description": "Credit card and loan recommendation setup with propensity scoring",
    "industry": "banking"
  },
  {
    "id": "retail",
    "name": "Retail & E-Commerce",
    "description": "Loyalty, promotions, and cart abandonment with seasonal campaigns",
    "industry": "retail"
  }
]

POST /api/v1/starter-kits//apply

Apply a starter kit to the current tenant. Creates all entities defined in the kit (schemas, offers, flows, rules, sample data).

Path Parameters

ParameterTypeDescription
kitstringStarter kit key: "telecom", "banking", or "retail"

Response

{
  "applied": true,
  "kit": "telecom",
  "tenantId": "tenant_001",
  "created": {
    "categories": 2,
    "offers": 5,
    "channels": 3,
    "contactPolicies": 4
  }
}
Applying a starter kit creates real entities in your tenant. Use on fresh tenants or playground instances to avoid conflicts with existing data.