Use the Signaliz TypeScript SDK

Install the official package:

npm install @signaliz/sdk

Create a client and keep the API key in the server environment:

import { Signaliz } from '@signaliz/sdk';const signaliz = new Signaliz({
  apiKey: process.env.SIGNALIZ_API_KEY,
});const result = await signaliz.enrichCompanySignals({
  domain: 'example.com',
  researchPrompt: 'Find recent expansion and partnership signals.',
});

The SDK includes typed methods for Company Signal Enrichment, Signals First, Signal to Copy, and Signal Awareness.

Safe automation patterns

Set dryRun: true to preview supported work without spending.
Set waitForResult: false when a long request should return its durable receipt immediately.
Persist the returned runId, jobId, and idempotencyKey.
Resume a durable batch with the corresponding resume*Batch method instead of submitting inputs again.
Treat success: false and terminal error payloads as failures even when transport succeeded.

Batch helpers accept up to 5,000 rows, preserve input order, isolate per-row errors, and retrieve result pages. Company Signal and Signal to Copy durable pages expire after seven days, so store completed results promptly.

Use the package's shipped types and current README as the method-level source of truth for your installed SDK version.