@entidex/sdk

Official TypeScript SDK for the Entidex entity-intelligence API.

Resolve any entity to its canonical record, then pull the complete, categorized intelligence record — AI Visibility, Sentiment, Share of Voice, Trust Stack, lifecycle stage, drift, cohort position and more — across every signal surface, in a single call.

Zero runtime dependencies. Works in Node 18+, Deno, Bun, edge runtimes, and the browser.

Install

npm install @entidex/sdk

Quick start

import { EntidexClient } from '@entidex/sdk';

const entidex = new EntidexClient({ apiKey: process.env.ENTIDEX_API_KEY });

// One call → the complete, categorized record
const record = await entidex.complete('tesla');

console.log(record.headline.aiVisibility);        // e.g. 76
console.log(record.categorization.lifecycleStage); // e.g. "Emergence"
console.log(record.categorization.surfacesPresent); // ["ai_engines", "press", ...]
console.log(record.meta.withheld);                 // sections your tier hasn't unlocked yet

No key? The client still works on the free, rate-limited tier — you'll get a generous taste (identity, categorization, headline signals, coverage). Higher tiers unlock scores, perception, derived insights, drift, decision survival and cohort additively; anything withheld is listed in record.meta.withheld with the tier that unlocks it.

API

const entidex = new EntidexClient({
  apiKey: 'entx_…',                       // optional — omit for the free tier
  baseUrl: 'https://entidex.com/api/v1',  // optional override
  fetch: customFetch,                     // optional — for Node <18 / testing
});

| Method | Returns | Notes | | --- | --- | --- | | resolve(query) | ReconciliationResult | name/alias → canonical id + confidence band | | getEntity(id, { include }) | Entity | identity; free tier returns the lite projection | | complete(id) | EntityComplete | the full categorized record in one call | | insights(id) | Partial<Record<ScoreDimension, Score>> | all score dimensions (insight tier) | | get<T>(path, params) | T | low-level escape hatch for any /v1 endpoint |

All methods return the unwrapped data payload, or throw EntidexApiError (with code, status, and the full errors[]).

import { EntidexApiError } from '@entidex/sdk';

try {
  const record = await entidex.complete('unknown-entity');
} catch (err) {
  if (err instanceof EntidexApiError) {
    console.error(err.code, err.status, err.message);
  }
}

Every type in the v1 contract is exported (EntityComplete, Score, DriftEvent, EntityCategorization, …) so you can build fully-typed pipelines on top of the record.

Links

• API reference: https://entidex.com/api
• Developer hub: https://entidex.com/developers
• MCP server: https://entidex.com/developers/mcp

License

MIT © ENTIDEX LTD