# Nephia

- [Introduction](https://docs.nephia.cc/introduction.md): The brand-monitoring API. Keywords, scored mentions, webhooks.
- [Quickstart](https://docs.nephia.cc/quickstart.md): Create your first keyword and read the mentions it catches, in minutes.
- [SDK (Node.js)](https://docs.nephia.cc/sdk.md): Official TypeScript client for the Nephia API.
- [MCP server](https://docs.nephia.cc/mcp-server.md): Your mentions, one prompt away — Nephia in Claude, Cursor, and any MCP client.
- [Skills](https://docs.nephia.cc/skills.md): Agent recipes for Nephia as SKILL.md files, from a daily brief to churn signals, installed beside the MCP server and run on your own schedule.
- [Authentication](https://docs.nephia.cc/authentication.md): Authenticate product API requests with an API key, or connect an agent over OAuth.
- [Errors](https://docs.nephia.cc/errors.md): HTTP status codes and the client error envelope.
- [Credits](https://docs.nephia.cc/credits.md): What polling and each call cost your Account.
- [Limits](https://docs.nephia.cc/limits.md): Request quota, keyword entitlements, and how your plan changes both.
- [Keywords](https://docs.nephia.cc/keywords.md): A keyword is what you monitor. It carries its terms, its Sources, its interval, its webhook and its exclusions.
- [Explore](https://docs.nephia.cc/explore.md): One question, every Source, priced first. Search once without creating a keyword.
- [Inbox](https://docs.nephia.cc/inbox.md): Follow your own X account, read each reply under its conversation, and answer it from Nephia.
- [Find people with your problem](https://docs.nephia.cc/find-your-problem.md): Build a keyword from a pain phrase instead of a brand name, then read only the mentions that need you.
- [Webhooks](https://docs.nephia.cc/webhooks.md): Receive tweet, post, video, Bluesky post, Hacker News item, article, and listing events from your keywords.
- [AI](https://docs.nephia.cc/ai.md): Group, classify, read and summarise items with one call, and attach an agent step to a keyword.
- [X](https://docs.nephia.cc/sources/x.md): What a keyword captures on X, and what arrives in each event.
- [Reddit](https://docs.nephia.cc/sources/reddit.md): What a keyword captures on Reddit, and what arrives in each event.
- [Youtube](https://docs.nephia.cc/sources/youtube.md): What a keyword captures on Youtube, and what arrives in each event.
- [TikTok](https://docs.nephia.cc/sources/tiktok.md): What a keyword captures on TikTok, and what arrives in each event.
- [Bluesky](https://docs.nephia.cc/sources/bluesky.md): What a keyword captures on Bluesky, and what arrives in each event.
- [Hacker News](https://docs.nephia.cc/sources/hackernews.md): What a keyword captures on Hacker News, and what arrives in each event.
- [Mastodon](https://docs.nephia.cc/sources/mastodon.md): What a keyword captures on Mastodon, and what arrives in each event.
- [Lemmy](https://docs.nephia.cc/sources/lemmy.md): What a keyword captures on Lemmy, and what arrives in each event.
- [GitHub](https://docs.nephia.cc/sources/github.md): What a keyword captures on GitHub, and what arrives in each event.
- [Product Hunt](https://docs.nephia.cc/sources/producthunt.md): What a keyword captures on Product Hunt, and what arrives in each event.
- [Stack Overflow](https://docs.nephia.cc/sources/stackoverflow.md): What a keyword captures on Stack Overflow, and what arrives in each event.
- [RSS & News](https://docs.nephia.cc/sources/rss.md): What a keyword captures on a feed or a news term, and what arrives in each event.
- [AI answers](https://docs.nephia.cc/sources/ai-answers.md): What ChatGPT, Gemini and Perplexity say about a prompt, tracked over time, with the brands they name and the sites they cite.
- [Vinted](https://docs.nephia.cc/sources/vinted.md): What a keyword captures on Vinted, plus the observed price history and market statistics.
- [n8n](https://docs.nephia.cc/integrations/n8n.md): The official Nephia nodes for n8n, a trigger that turns a keyword into a workflow and an action node covering the /v1 API.
- [Overview](https://docs.nephia.cc/api-reference/overview.md): Conventions for the Nephia product API.
- [List mentions](https://docs.nephia.cc/api-reference/mentions/list-mentions.md): Everything your keywords caught, newest first, across every Source and every keyword on the Account, annotated with the sentiment, intent and agent readings you have switched on, and filterable on both. Cursor-paged: pass the response `nextCursor` back unchanged. Its absence means the last page. To…
- [Count mentions](https://docs.nephia.cc/api-reference/mentions/count-mentions.md): Counts your mentions instead of paging them: how many, when, where, by whom and on which terms, in one call. `group_by` takes one or two axes among `day`, `hour`, `source`, `sentiment`, `intent`, `author`, `term` and `keyword`, and `rows` holds one count per combination. A combination with nothing i…
- [Find similar mentions](https://docs.nephia.cc/api-reference/mentions/find-similar-mentions.md): Up to ten mentions that say something close to this one, most similar first, across every keyword and kept Explore run on the Account. The id is a mention's `id` from any mention read, collected in the last 30 days. Copies of the same post are collapsed and the mention you asked about never comes ba…
- [List keywords](https://docs.nephia.cc/api-reference/keywords/list-keywords.md): Every keyword on your Account, with the events each caught in the last 24 hours, each Source's `health` and how many of them are `stale`. Report a stale Source before answering from its mentions. Free: does not charge credits.
- [Create a keyword](https://docs.nephia.cc/api-reference/keywords/create-a-keyword.md): Creates a keyword and starts polling each of its searches. The body, the plan limits, the interval floors and the multi-term rules are **exactly** the ones the dashboard applies: a keyword this refuses is one the Configure screen would refuse too, with the same error code. Pass `backfill: true` to r…
- [Estimate a keyword](https://docs.nephia.cc/api-reference/keywords/estimate-a-keyword.md): What `POST /v1/keywords` would do with this body, **without creating anything or charging anything**. The body is the create body, and it goes through the create's own validation (plan limits, interval floors, multi-term rules, channels, collisions), so `valid: false` carries the status, code and re…
- [Get a keyword](https://docs.nephia.cc/api-reference/keywords/get-a-keyword.md): One keyword, with what each of its searches actually polls (global criteria and per-search overrides already merged), when each Source was last checked (`health`) and the delivery channels attached to it. Report a stale Source before answering from its mentions. Free: does not charge credits.
- [Update a keyword](https://docs.nephia.cc/api-reference/keywords/update-a-keyword.md): A real patch: **a key you do not send is left alone**, and a key sent as `null` clears it. The difference matters: a search whose terms, filters or market change is started over, and its first check records what currently matches without emitting it. The mentions it caught before stay on the keyword…
- [Estimate a keyword update](https://docs.nephia.cc/api-reference/keywords/estimate-a-keyword-update.md): What `PATCH /v1/keywords/{id}` would do with this body, **without changing anything or charging anything**. Same validation as the patch, so `valid: false` carries the refusal it would answer. A valid body comes back with the keyword's monthly credits after the patch, before it (`previousMonthlyCred…
- [Deactivate a keyword](https://docs.nephia.cc/api-reference/keywords/deactivate-a-keyword.md): Stops the keyword and its searches for good and frees the plan slot. Without `purge`, deliberately not a hard delete: the keyword leaves `GET /v1/keywords` but stays readable by id with `isActive: false`, and the mentions it caught stay readable until retention ages them out: you retired a monitor,…
- [List a keyword's mentions](https://docs.nephia.cc/api-reference/keywords/list-a-keywords-mentions.md): The same mentions as `GET /v1/mentions`, scoped to one keyword and carrying its **bucket** verdict. Filter to a bucket with `bucket=`, using an id from `GET /v1/keywords/{id}/buckets` or the literal `uncategorised`. Cursor-paged: pass the response `nextCursor` back unchanged. Its absence means the l…
- [Replay a keyword's webhook events](https://docs.nephia.cc/api-reference/keywords/replay-a-keywords-webhook-events.md): The items this keyword caught, each in **exactly the body its webhook delivers**, newest first, across every Source and every search of the keyword, including what its searches caught before they last changed. This is the raw entity (`listing`, `tweet`, `post`, `previousPrice` and the rest), where `…
- [List a keyword's polling and delivery activity](https://docs.nephia.cc/api-reference/keywords/list-a-keywords-polling-and-delivery-activity.md): What Nephia did for this keyword, newest first: every check of every Source (`poll.completed` with the items it emitted and the credits it charged, or `poll.failed` with the reason) and every webhook delivery (`webhook.delivered` or `webhook.failed`, with the status code your endpoint answered and t…
- [List a keyword's stored AI answer runs](https://docs.nephia.cc/api-reference/keywords/list-a-keywords-stored-ai-answer-runs.md): Every run the AI answers Source made for this keyword, newest first, including the runs that changed nothing and emitted no event, which is most of them and exactly what a trend is made of. Empty for a keyword that does not monitor AI answers. `since` defaults to the last 7 days; `engine` narrows to…
- [List a keyword's buckets](https://docs.nephia.cc/api-reference/keywords/list-a-keywords-buckets.md): The buckets a listening keyword sorts its mentions into, with a count each. Use the ids to filter `GET /v1/keywords/{id}/results`. Read-only and free: it never triggers a sorting pass, so listing buckets cannot bill.
- [Create a bucket](https://docs.nephia.cc/api-reference/keywords/create-a-bucket.md): Adds a bucket to a listening keyword: a name and one plain-language sentence saying what belongs in it. The model reads the sentence, not a list of words. Mentions already sorted stay where they are; the next sorting pass reads the new bucket. Refused on a catalog keyword and when a bucket of that n…
- [Delete a bucket](https://docs.nephia.cc/api-reference/keywords/delete-a-bucket.md): Retires a bucket. The mentions sorted into it are not deleted: they become uncategorised, and `unclassified` says how many. Free: does not charge credits.
- [Pause a keyword](https://docs.nephia.cc/api-reference/keywords/pause-a-keyword.md): Stops every search of the keyword. Nothing is polled, nothing is charged and nothing is delivered until you resume; the mentions already caught stay readable.
- [Resume a keyword](https://docs.nephia.cc/api-reference/keywords/resume-a-keyword.md): Starts every search that can follow. A Source an operator stopped stays stopped and is named in `blockedSources` rather than failing the call — the other Sources have no reason to stay down for it.
- [Pause one of a keyword's sources](https://docs.nephia.cc/api-reference/keywords/pause-one-of-a-keywords-sources.md): Stops the searches of one Source and leaves the keyword's other Sources polling. Nothing on that Source is polled, charged or delivered until you resume it; its searches and the mentions it caught stay. Refused when the Source is not enabled on the keyword, when the keyword itself is paused, and whe…
- [Resume one of a keyword's sources](https://docs.nephia.cc/api-reference/keywords/resume-one-of-a-keywords-sources.md): Starts the searches of one Source again. A Source an operator stopped stays stopped and is named in `blockedSources` rather than failing the call. Free: does not charge credits; the polling it restarts is charged per check at the Source's rate.
- [List brands](https://docs.nephia.cc/api-reference/keywords/list-brands.md): The brands on your Account: id, name, site, and which one is the default. A keyword's drafts speak for one of them; choose it with `PUT /v1/keywords/{id}/brand`. The brand card itself (description, facts, pages read from the site) is edited in the dashboard and is not part of this API. Free: does no…
- [Get a keyword's brand](https://docs.nephia.cc/api-reference/keywords/get-a-keywords-brand.md): The brand this keyword's drafts speak for: what the keyword stores (`brandProfileId`, null for the account's default) and the brand that resolves to. Free: does not charge credits.
- [Set a keyword's brand](https://docs.nephia.cc/api-reference/keywords/set-a-keywords-brand.md): Chooses the brand this keyword's drafts speak for, by an id from `GET /v1/brands`. null goes back to the account's default. Nothing is polled differently and no search starts over. A brand id that is not on your Account is a 404. Free: does not charge credits.
- [Get credit balance](https://docs.nephia.cc/api-reference/account/get-credit-balance.md): Returns the remaining pull credits for your Account. Free — does not charge credits.
- [Run an AI pass over items](https://docs.nephia.cc/api-reference/ai/run-an-ai-pass-over-items.md): Runs one of four passes over up to 200 items: **group** them by a plain-language instruction, **classify** them into buckets you define, run an **agent** step (your instruction plus your schema, answered per item), or **summarise** the set.
- [Price an AI pass](https://docs.nephia.cc/api-reference/ai/price-an-ai-pass.md): Free. Returns what `POST /v1/analyses` would charge for that many items, computed by the same functions that charge it.
- [Get an item price history](https://docs.nephia.cc/api-reference/vinted-analytics/get-an-item-price-history.md): Costs 3 credits per request. Returns every price and status Nephia observed for one item, oldest first. A point is recorded when the price or status changed, or once every 24 hours while it did not — so consecutive points are movements, not poll ticks. Coverage grows with usage: a series exists only…
- [Get market price statistics](https://docs.nephia.cc/api-reference/vinted-analytics/get-market-price-statistics.md): Costs 5 credits per request. Returns p25 / median / p75 and a count per day, newest first, over the observations Nephia holds for a market. Defaults to the last 30 days; a range may not exceed 365 days. Days are also split by currency, so percentiles are never averaged across two of them. `soldRate`…

## OpenAPI Specs

- [openapi](/openapi.json)


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