> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nephia.cc/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> The brand-monitoring API. Keywords, scored mentions, webhooks.

Nephia is the **monitoring API** for brands, names and markets across live Sources (X, Reddit, Youtube, Bluesky, Hacker News, RSS, AI answers — and Vinted).

You create a **keyword**: its terms, the Sources you switch on, an interval, and optionally a webhook and exclusions. Nephia polls it, keeps what matches, reads each mention for sentiment and intent, sorts it into your buckets, and answers your own agent step over it. Read the result back with `GET /v1/mentions` (free, across every Source and every keyword) or have it POSTed to you as a signed webhook event. One keyword can carry several **terms** at once (a brand plus its variants), OR'd into a single upstream request at one tick's cost. See [Keywords](/keywords).

To start with what a Source already holds, create the keyword with `backfill: true` (see [Day-one backfill](/keywords#backfill)).

## Sources

Each **Source** has its own coverage, criteria and event shape. See [X](/sources/x), [Reddit](/sources/reddit), [Youtube](/sources/youtube), [Bluesky](/sources/bluesky), [Hacker News](/sources/hackernews), [RSS & News](/sources/rss), [AI answers](/sources/ai-answers), and [Vinted](/sources/vinted). Watching a clothing brand or sourcing resale? Vinted is a first-class Source, with observed price history and market statistics on top of its listings.

## What the API sells

**Keywords and their mentions.** `POST /v1/keywords` sets the monitoring up, `GET /v1/mentions` reads what it caught, annotated. Reading your own mentions is free; a keyword's poll ticks are what deduct credits, see [Credits](/credits#polling). See [Keywords](/keywords).

Alongside them: [webhooks](/webhooks), [`POST /v1/analyses`](/ai) over what your keywords collected, AI-answer runs, and Vinted's observed price history and market statistics.

<h2 id="history">
  History & backfill
</h2>

A keyword starts recording the moment it exists, and by default it starts **empty**: the
first poll of each Source records what is there without emitting it, and everything
after that is news. Two things change that.

**`backfill: true` on `POST /v1/keywords`** runs one immediate search per enabled Source
and stores the results as the keyword's starting history, so `GET /v1/keywords/{id}/results`
answers with content straight away. It costs **one tick per Source** at that Source's
rate, or on X 5 credits plus 3 per tweet returned, at most 65 (see
[Credits](/credits#polling)); it notifies nobody, no webhook and no
channel, and the rows come back with `"seeded": true`. The default is `false`: an
API default never spends. More under
[Keywords: Day-one backfill](/keywords#backfill).

**History beyond the first page** is a dashboard gesture. On the Sources whose upstream
can be asked for older items (Hacker News, Reddit, Bluesky, X, GitHub, YouTube, Stack
Overflow, Lemmy and Mastodon), a keyword can be handed its last **60 days**, read one page
at a time up to five pages per Source, each page charged one tick, and on X charged per
tweet returned: at most 65 a page and 325 for the whole history. RSS feeds, AI answers
and Vinted listings are not swept: a feed serves what it serves, an answer engine has no
archive, and old listings are inventory rather than mentions. Seeded rows never trigger a
webhook, a channel, a rule or an agent step, and never count toward a spike alert.

## Auth

All product API calls use an API key tied to your **Account** (billing tenant). See [Authentication](/authentication).

## Limits

What a plan sells is **keywords × terms × freshness**: how many things you watch, how many
terms each search carries, and how often we check ([Limits](/limits)). **Credits** are the
meter underneath — what each call and each tick costs ([Credits](/credits)) — plus the
per-Account request quota on `/v1/*`. Credit packs top the meter up and never change a
limit.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.