Skip to main content

​
Base URL

https://playground.kaireonai.com/api/v1
For local development: http://localhost:3000/api/v1

​
Authentication

All API requests require authentication via session cookie or API key header: 
Authorization: Bearer <your-api-key>

​
Core Endpoints

​
Recommend API

Get personalized offer recommendations for a customer. 
POST /api/v1/recommend
Request: 
{
  "customerId": "CUST001",
  "channel": "email",
  "limit": 3,
  "attributes": {
    "tier": "gold",
    "region": "northeast"
  }
}
Response: 
{
  "interactionId": "int_abc123",
  "recommendations": [
    {
      "offerId": "offer_1",
      "name": "Platinum Card",
      "score": 0.92,
      "personalization": {
        "personalized_rate": 0.12
      }
    }
  ]
}

​
Respond API

Record the outcome of a recommendation. 
POST /api/v1/respond
Request: 
{
  "interactionId": "int_abc123",
  "outcome": "accepted",
  "offerId": "offer_1"
}

​
CRUD Endpoints

All entity types follow standard REST patterns:
MethodPatternDescription
GET/api/v1/{entity}List all
GET/api/v1/{entity}/{id}Get by ID
POST/api/v1/{entity}Create
PUT/api/v1/{entity}/{id}Update
DELETE/api/v1/{entity}/{id}Delete
Available entities: actions (offers), categories, sub-categories, channels, treatments (creatives), decision-flows, schemas, connectors, pipelines, arbitration-profiles, content-items, journeys.