Quickstart

Get your first agent event into Kaplaix in under 5 minutes.

Prerequisites

An Kaplaix account with an API key (al_live_...)
Node.js >= 18 or Python >= 3.10

1. Install the SDK

TypeScript


npm install @kaplaix/sdk-ts

Python


pip install kaplaix

2. Send your first event

TypeScript


import { KaplaixClient } from "@kaplaix/sdk-ts";
 
const client = new KaplaixClient({ apiKey: "al_live_..." });
const session = client.session({ agentId: "my-agent" });
 
await session.logToolCall({
  toolName: "web_search",
  argumentsHash: "sha256-of-args",
  responseStatus: 200,
});
 
await session.end();
await client.shutdown();

Python


from kaplaix import KaplaixClient
 
client = KaplaixClient(api_key="al_live_...")
 
with client.session(agent_id="my-agent") as session:
    session.log_tool_call("web_search", "sha256-of-args", response_status=200)

cURL


curl -X POST https://api.kaplaix.com/v1/events \
  -H "Authorization: Bearer al_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "eventId": "550e8400-e29b-41d4-a716-446655440000",
    "agentId": "my-agent",
    "sessionId": "session-001",
    "sourceTimestamp": "2025-01-15T10:30:00Z",
    "category": "tool_api",
    "schemaVersion": "1.0",
    "payload": {
      "toolName": "web_search",
      "argumentsHash": "sha256-of-args",
      "responseStatus": 200
    }
  }'

You should receive a 202 Accepted response:


{
  "eventId": "550e8400-e29b-41d4-a716-446655440000",
  "receivedAt": "2025-01-15T10:30:01.234Z",
  "warnings": []
}

3. View the session

Retrieve the session and its events:


curl https://api.kaplaix.com/v1/sessions/session-001 \
  -H "Authorization: Bearer al_live_..."

4. Check the risk score


curl https://api.kaplaix.com/v1/sessions/session-001/risk \
  -H "Authorization: Bearer al_live_..."

The Risk Engine scores every session across 10 OWASP-aligned dimensions and returns explainable factors with recommendations.

What’s next?

Concepts — Understand the core data model
TypeScript SDK — Full SDK reference with Guardian Mode
Python SDK — Full SDK reference
Event Schema — The 7 canonical event categories