@iterium/sdk

Official TypeScript client for Iterium — talk to your autonomous Scrum Master agent, pull live workspace stats, and manage the Add-ons waitlist from your own code, scripts, or backend.

Install

Inside this monorepo it's already linked as a workspace package. Standalone:

npm install @iterium/sdk

Quick start

import { IteriumClient } from "@iterium/sdk";

const iterium = new IteriumClient({
  baseUrl: "https://my-team.vercel.app", // your Iterium deployment
  workspaceId: "TENANT-99X",             // your Slack workspace / tenant id
});

// Talk to the agent — same tool loop as the dashboard Terminal and Slack.
const answer = await iterium.chat({
  messages: [{ role: "user", content: "Analiza el ticket Jira PROJ-1" }],
});
console.log(answer);

// Stream the response token-by-token instead.
for await (const delta of iterium.chatStream({
  messages: [{ role: "user", content: "Revisa el PR #234 de GitHub" }],
})) {
  process.stdout.write(delta);
}

// Structured sprint report.
const sprint = await iterium.getSprintSummary(
  "Sprint 42 del equipo Backend, 3 días restantes, PROJ-100 bloqueado por QA"
);
console.log(sprint.overallHealth, sprint.blockers);

// Live dashboard stats.
const stats = await iterium.getStats();

// Add-ons marketplace.
const { modules, requested } = await iterium.listAddons();
await iterium.toggleAddonWaitlist("qa");

API

| Method | Description | | --- | --- | | chat({ messages }) | Sends a message to the agent, returns the full text response. | | chatStream({ messages }) | Same, but an AsyncGenerator<string> yielding text deltas as they arrive. | | getSprintSummary(prompt) | Structured { velocity, blockers, recommendations, ... } sprint report. | | getStats() | Live workspace stats (messagesToday, blockersResolved, computeUsed, cacheHitRate). | | listAddons() | The Add-ons catalog plus which ones this workspace already requested. | | toggleAddonWaitlist(addonId) | Joins/leaves an Add-on's waitlist. |

All requests are scoped by workspaceId; pass a per-user userId too if you want per-user attribution in Iterium's logs.

Errors throw IteriumApiError with a .status (HTTP status code) you can branch on.

Build

pnpm --filter @iterium/sdk build