# SigWise

> SigWise reads the events and messages on your platform and answers the questions you care about as typed signals. Guides, API reference and SDKs.

SigWise is an API for platforms with users, listings or orders. You send it the events and messages about each object, define the questions you care about as signals (a yes/no probability, a labelled score, or one of several categories, written in plain language), and read typed answers back, in the background or inline before content is published. Typical uses are marketplace scam detection, user trust scores, buyer intent and lead scoring, and chat moderation.

- Website: https://sigwise.ai (as Markdown: https://sigwise.ai/index.md)
- Pricing: usage-based, no subscription. $5 free credit for every new account, then a prepaid balance billed per analysis at model cost, typically a fraction of a cent.
- Sign up: https://sigwise.ai/register
- SDKs: Node.js, Python, Go and PHP, generated from the OpenAPI 3.1 specification.

Every page of these docs is available as Markdown: add `.md` to its URL.
The API is described by an OpenAPI 3.1 specification: https://sigwise.ai/docs/openapi.json (also /openapi.yaml).

## Getting started

- [Introduction](https://sigwise.ai/docs/guide/introduction.md): What SigWise does: typed answers (signals) about the objects on your platform, computed from the events and messages you send.
- [Quickstart](https://sigwise.ai/docs/guide/quickstart.md): From an API key to your first signal, event and answer in five minutes, with cURL and SDK examples.
- [Authentication](https://sigwise.ai/docs/guide/authentication.md): How to sign every request with an HS256 JWT made from your API key's secret, with examples in five languages.
- [Core concepts](https://sigwise.ai/docs/guide/concepts.md): Accounts, objects, events, signals, analysis and results, and how debouncing, priorities and compaction work.
- [Signals](https://sigwise.ai/docs/guide/signals.md): The three signal types (noul, score, choice), how to write their instructions and criteria, and how changes take effect.

## Guides

- [Ingesting events](https://sigwise.ai/docs/guides/ingesting-events.md): Sending events and messages about an object: fields, debouncing, limits, validation and re-analysis.
- [Direct moderation](https://sigwise.ai/docs/guides/moderation.md): Scoring content inline with wait: true to block, hold or publish it before anyone sees it.
- [Reading results](https://sigwise.ai/docs/guides/reading-results.md): Reading an object's latest answers, caching, waiting for analyses, and listing and filtering objects.
- [Search and conditions](https://sigwise.ai/docs/guides/queries.md): The comparison language shared by object search and rule conditions, and how values work per signal type.
- [Webhooks](https://sigwise.ai/docs/guides/webhooks.md): Registering endpoints, the analysis.completed payload, verifying signatures, retries and the dead-letter queue.
- [Rules](https://sigwise.ai/docs/guides/rules.md): Conditions over signal values that fire email, Slack or webhook actions, with transition-based firing, cooldowns and an audit log.
- [Backfills](https://sigwise.ai/docs/guides/backfills.md): Answering a new signal for existing objects: estimating the cost, starting a backfill and following its progress.
- [API keys](https://sigwise.ai/docs/guides/api-keys.md): Creating, rotating, deactivating and revoking API keys, and practices for keeping secrets safe.
- [Billing and usage](https://sigwise.ai/docs/guides/billing.md): The prepaid balance, what happens when it runs out, adding funds, the ledger and usage reports.
- [Errors and retries](https://sigwise.ai/docs/guides/errors.md): The error envelope, every status and error code, and which requests are safe to retry.

## Use cases

- [Marketplace scam detection](https://sigwise.ai/docs/use-cases/marketplace-scam-detection.md): Detect marketplace scammers from their messages and actions: off-platform payment requests, overpayment scams, phishing links and account takeovers, scored per user with SigWise.
- [User trust scores](https://sigwise.ai/docs/use-cases/user-trust-scores.md): Compute a trust score for every user from their behaviour and messages, with labelled levels you define, and use it to gate payouts, limits and verification.
- [Buyer intent and lead scoring](https://sigwise.ai/docs/use-cases/buyer-intent.md): Classify where each user or lead is in a purchase from their messages and actions, and route ready-to-buy leads to sales in real time with SigWise.
- [Chat and content moderation](https://sigwise.ai/docs/use-cases/chat-moderation.md): Moderate chat messages, listings and reviews before they are published, with policies written in plain language and each author's history taken into account.

## Compare

- [SigWise vs. moderation APIs](https://sigwise.ai/docs/compare/moderation-apis.md): How SigWise differs from content moderation APIs such as OpenAI's Moderation endpoint: custom questions instead of fixed harm categories, per-user history instead of single messages, and when to use each.
- [SigWise vs. building on an LLM API](https://sigwise.ai/docs/compare/build-it-yourself.md): What it takes to build user scoring on a raw LLM API yourself (history, debouncing, typed outputs, queues, webhooks, rules, billing) and what SigWise gives you instead.

## Reference

- [API reference](https://sigwise.ai/docs/reference.md): Every endpoint, parameter, response and schema of the SigWise API.
- [SDKs](https://sigwise.ai/docs/sdks.md): The Node.js, Python, Go and PHP SDKs generated from the OpenAPI specification, and what each one does for you.
- [OpenAPI specification](https://sigwise.ai/docs/guide/openapi.md): Where to get the OpenAPI 3.1 specification and how to use it with your tools.
- [For AI agents](https://sigwise.ai/docs/guide/agents.md): How AI agents and LLM tools can read these docs and the API contract as Markdown and JSON.
- [Changelog](https://sigwise.ai/docs/changelog.md): New features and changes to the SigWise API, console, docs and SDKs, newest first.

## Optional

- [OpenAPI specification (JSON)](https://sigwise.ai/docs/openapi.json): the machine-readable API contract
- [OpenAPI specification (YAML)](https://sigwise.ai/docs/openapi.yaml)
- [Everything in one file](https://sigwise.ai/docs/llms-full.txt): all of the pages above, concatenated