Quickstart

This guide walks you through making your first request to the Qualia API: creating an actor and fetching the briefing once enrichment completes.

1. Get an API key

Create a key in Settings → API Keys. Copy the plaintext. It is shown once.

export QUALIA_API_KEY="qk_live_..."

To persist across shells, append the line above to ~/.zshrc or ~/.bashrc.

2. Create an actor

// app/qualia.ts
import { Qualia } from "@qualiaso/sdk";

const qualia = new Qualia({
  auth: () => process.env.QUALIA_API_KEY!,
});

const { data, error } = await qualia.createActor({
  body: {
    email: "anna@ridgeline.co",
    name: "Anna Park",
    source: "product_signup",
  },
});

if (error) throw error;

const { actorId, status } = data;

The response is { actorId, status }. status is "created" for a new actor (enrichment is enqueued) or "already_exists" if an actor with this email already exists in your organization.

3. Read the briefing

Enrichment runs asynchronously. Poll the actor until status is "enriched" (success) or "failed" (terminal failure).

// app/qualia.ts
const { data: actor, error } = await qualia.getActor({
  path: { actorId },
});

if (error) throw error;

console.log(actor.status, actor.intelligence);

Once status is "enriched", the enrichment and intelligence fields are populated.

Next

• Concepts. The shape of an actor and a briefing.
• API reference. Every operation page with request and response schemas.