Quickstart

This page shows the shortest path from installing the SDK to seeing an agent run in Lynx.

Lynx is currently in pilot. To join the pilot or evaluate it for your service, contact partners@hvnn.me.

When to use this

Use this guide when you want to connect a TypeScript service and record one agent run with user input, context, a decision, and an outcome.

Setup

Install the SDK.

npm install @lynxops/sdk

You can also use pnpm or Yarn.

pnpm add @lynxops/sdk
yarn add @lynxops/sdk

Create a tracer.

import { LynxTracer } from "@lynxops/sdk";

const lynx = new LynxTracer({
  clientId: "support-api",
  apiKey: process.env.LYNX_API_KEY,
  workspaceId: process.env.LYNX_WORKSPACE_ID,
  environment: "production",
});

If you omit endpoint, the SDK sends events to https://api.lynxops.co.

Example

Wrap one agent execution in run(). Events recorded inside the callback are attached to the same run and session.

await lynx.run("SupportAgent", async () => {
  lynx.userInput("I want a refund", { userId: "usr_123" });
  lynx.setAttributes({ orderId: "order_123" });

  lynx.context("refund-policy", {
    refundWindowDays: 30,
  });

  lynx.decision({
    name: "select_refund_workflow",
    selected: "refund",
    confidence: 0.82,
    reason: "The order is inside the refund window",
  });

  lynx.outcome({
    status: "COMPLETED",
    businessStatus: "SUCCEEDED",
    reason: "Refund request was accepted",
  });
});

What you can see in Lynx

After the SDK sends events, Lynx can show:

The session timeline
The user input that started the run
Context loaded by the agent
Agent decisions and reasons
The final technical and business outcome

Shut down safely

For long-running servers, call shutdown() in your shutdown hook. For serverless handlers, call it before the handler exits if you want a best-effort final flush.

process.on("SIGTERM", () => {
  void lynx.shutdown({ timeoutMs: 1000 });
});

Delivery is background-only by default. Failed event delivery does not throw from your agent workflow.

Getting started

TypeScript SDK

OpenAPI

When to use this

Setup

Example

What you can see in Lynx

Shut down safely

Next steps

​When to use this

​Setup

​Example

​What you can see in Lynx

​Shut down safely

​Next steps

When to use this

Setup

Example

What you can see in Lynx

Shut down safely

Next steps