Quick Start

Go from zero to a fully governed AI agent in about ten minutes. This guide walks you through every step from account creation to your first policy-checked action.

Prerequisites

You need a modern web browser and a working AI agent (or a test script) that can make HTTP requests. Koladr provides a TypeScript SDK, but any language that can call REST APIs will work.

1. Create Your Account

Visit the Koladr sign-up page and create an account with your email address. You will receive a verification email — click the link to confirm your address and activate your account.

If your team already uses Koladr, ask your workspace admin to send you an invitation. You can accept the invite during sign-up and skip workspace creation.

2. Create a Workspace

After signing in for the first time, Koladr will guide you through onboarding. Enter a workspace name — this is usually your company or team name. The workspace is the container for all your agents, policies, and team members.

You can always rename it later in Settings → Workspace.

3. Open the Dashboard

Once your workspace is set up, you land on the Dashboard. This is your command center — it shows live metrics for runs, actions, approval queues, and active incidents. It will be empty at first, but it will populate as you start sending data.

4. Register an Agent

Navigate to Agents in the sidebar and click Register Agent. Give your agent a descriptive name (e.g. "Support Bot" or "Refund Processor") and an optional description.

Registration creates the agent's identity in Koladr. All runs and actions from this agent will be tracked under this identity.

5. Generate an API Key

Go to Settings → API Keys and create a new key for your agent. Copy the key immediately — it will only be shown once.

Store your API key securely

Treat your API key like a password. Store it in your environment variables or a secrets manager. Never commit it to source control.

6. Install the SDK

Install the Koladr SDK in your agent's project:

npm install @koladr/sdk

Initialize the client with your API key and agent ID:

import { KoladrClient } from "@koladr/sdk";

const koladr = new KoladrClient({
  apiKey: process.env.KOLADR_API_KEY!,
  agentId: "your-agent-id",
});

7. Start Logging Runs

Every time your agent begins a task, start a run:

const run = await koladr.startRun({
  trigger: "support-ticket",
  metadata: { ticketId: "TKT-1042" },
});

Log events as the agent processes the task:

await koladr.logEvents(run.id, [
  { type: "context.retrieved", data: { source: "knowledge-base" } },
  { type: "intent.classified", data: { intent: "refund-request" } },
]);

8. Route Actions Through Koladr

When your agent needs to take a real-world action, request it through Koladr instead of executing it directly:

const result = await koladr.requestAction(run.id, {
  action: "refund.create",
  params: { amount: 29.99, currency: "USD", reason: "Product defect" },
});

if (result.status === "approved") {
  // action was executed
} else if (result.status === "pending_approval") {
  // waiting for human review
} else if (result.status === "blocked") {
  // policy blocked this action
}

9. Create Your First Policy

Go to Policies in the sidebar and create a new policy. A good first policy might be:

  • Name: Refund approval for high amounts
  • Condition: Action is refund.create and amount > 50
  • Effect: Require approval

This ensures that any refund over $50 gets reviewed by a human before executing, while smaller refunds can proceed automatically.

10. Review Approvals and Incidents

Check the Approvals page to see any pending actions. Approvers can review the full context — the agent, run timeline, and action details — before approving or rejecting.

If any actions are blocked or fail, check the Incidents page. Each incident links back to the run that triggered it, so you can trace the full story.

11. Go Live Safely

Before going to production, walk through the Production Checklist to make sure everything is configured correctly. Start with conservative policies (require approval for most actions) and relax them as you build confidence.

Start strict, then loosen

It is always safer to start with more approvals than you think you need. You can always reduce friction later — but you cannot undo an action that already executed.

Next

Account & Workspace Setup

Detailed guide on workspaces, roles, and team setup