Kaiten
Getting Started

Create a Customer & Instance

Create your first customer and instance using the dashboard or the REST API.

Create Your First Customer & Instance

In Kaiten, Customers represent your end clients, and Instances represent deployments of your product for each customer.

1. Create a Customer

  1. Navigate to Customers in the sidebar
  2. Click New Customer
  3. Fill in:
    • Name: My Restaurant
    • Slug: my-restaurant (auto-generated from name)
    • External Customer ID (optional): your CRM reference
  4. Click Create
curl -X POST http://localhost:6000/api/customers \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Restaurant",
    "slug": "my-restaurant"
  }'

Response:

{
  "id": "uuid-...",
  "name": "My Restaurant",
  "slug": "my-restaurant",
  "createdAt": "2025-01-01T00:00:00Z"
}

2. Create an Instance

Each customer can have one or more instances. An instance must be linked to a License (which defines what the customer can use).

  1. Click on your customer My Restaurant
  2. Go to the Instances tab
  3. Click New Instance
  4. Fill in:
    • Name: My Restaurant Production
    • Slug: my-restaurant-production
    • Description: Production environment
    • License: Select one (e.g. "Starter" from the demo data)
  5. Click Create
curl -X POST http://localhost:6000/api/instances \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Restaurant Production",
    "slug": "my-restaurant-production",
    "description": "Production environment",
    "customerId": "<customer-id>",
    "licenseId": "<license-id>"
  }'

The Core Chain

You've just built the fundamental Kaiten hierarchy:

Organization (your workspace)
└── Customer: "My Restaurant"
    └── Instance: "My Restaurant Production"
        └── License: "Starter" (defines entitlements & limits)

Every operation in Kaiten — feature flag evaluation, entitlement usage tracking, webhook events — is scoped to this chain.

Next Step

Set Up Licenses & Entitlements

On this page