Quickstart

This guide takes you from a new account to your first event in Analytics and your first agent run. You need a terminal with curl, or Node.js 18 or later if you prefer TypeScript.

Create a workspace

Sign up and create a workspace. A workspace holds your data, members, API keys and settings. Choose its data region now: EU (Frankfurt) or US (Oregon). The region cannot be changed later without a migration.

Every new workspace starts on Starter with all five modules enabled.

Create an API key

In the app, open Settings, API keys and choose Create key. Give it a label such as local-dev and the scopes events:write and agents:run. The full key is shown once. Store it in your shell:

export CL_API_KEY="cl_live_4f1c9a...e210"

Keys are prefixed cl_live_ for production and cl_test_ for test mode. Test-mode data is isolated and can be wiped from settings at any time.

Send your first event

Events are the shared record every module reads. Send one with curl:

curl https://api.consciouslab.xyz/v1/events \
  -H "Authorization: Bearer $CL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "checkout.completed",
    "entity": "order/ORD-88214",
    "actor": "customer/cus_Halvorsen",
    "data": { "amount": 182.40, "currency": "EUR" }
  }'

The response contains the event ID and the time we received it:

{ "id": "evt_01J9ZQ3M1F4X", "received_at": "2026-10-17T13:51:02.448Z" }

Open Analytics, Live events in the app and the event appears within a second.

Or use the TypeScript SDK

npm install @consciouslab/sdk

import { ConsciousLab } from '@consciouslab/sdk';

const cl = new ConsciousLab({ apiKey: process.env.CL_API_KEY! });

await cl.events.send({
  type: 'checkout.completed',
  entity: 'order/ORD-88214',
  actor: 'customer/cus_Halvorsen',
  data: { amount: 182.4, currency: 'EUR' },
});

The SDK batches events, retries on network errors with exponential backoff and adds an idempotency key to every request.

Run an agent

Every workspace includes a sample agent called hello-ops with one read-only tool. Start a run and stream its steps:

const run = await cl.agents.run('hello-ops', {
  input: 'Summarise the last 10 checkout events.',
});

for await (const step of run.stream()) {
  console.log(step.kind, step.summary);
}

Next steps

• Read Concepts to understand entities, actors and the Sense, Reason, Act loop.
• Set up authentication for production, including key rotation.
• Browse the API overview for conventions shared by every endpoint.