Skip to main content

GET /api/v1/starter-kits

List available starter kits.

Response

{
  "kits": [
    {
      "key": "telecom",
      "name": "Telecom Cross-Sell",
      "description": "Complete setup for telecom cross-sell/upsell with 5 offers, 2 flows, qualification rules, and sample customer data",
      "entityCounts": { "offers": 5, "flows": 2, "rules": 3, "schemas": 2, "contacts": 1000 }
    },
    {
      "key": "banking",
      "name": "Retail Banking",
      "description": "Credit card and loan recommendation setup with propensity scoring",
      "entityCounts": { "offers": 8, "flows": 3, "rules": 5, "schemas": 3, "contacts": 2000 }
    }
  ]
}

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 (e.g., "telecom", "banking")

Response

{
  "applied": true,
  "kit": "telecom",
  "created": {
    "schemas": 2,
    "offers": 5,
    "flows": 2,
    "rules": 3,
    "sampleRecords": 1000
  }
}
Applying a starter kit creates real entities in your tenant. Use on fresh tenants or playground instances to avoid conflicts with existing data.