> ## 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.

# Quickstart

> Create your first keyword and read the mentions it catches, in minutes.

## 1. Sign in to the dashboard

Open the [Nephia dashboard](https://nephia.cc/dashboard) and sign in with Google or a sign-in link. Your **Account** is provisioned automatically on first sign-in.

## 2. Create an API key

Go to **API Keys** and create a key. Copy it immediately — it is shown only once.

## 3. Create a keyword

A **keyword** carries its terms, its Sources and its interval. Nephia polls every Source
you switch on, keeps what matches, and reads each mention for sentiment and intent. Swap `figma` for your own brand.

### Node.js SDK

```bash theme={null}
npm install nephia
```

```ts theme={null}
import { Nephia } from "nephia";

const client = new Nephia({ apiKey: "YOUR_API_KEY" });

const keyword = await client.keywords.create({
  name: "figma",
  refreshIntervalSeconds: 900,
  globalCriteria: { market: "fr", terms: ["figma", "figma alternative"] },
  sources: [
    { source: "reddit", enabled: true },
    { source: "x", enabled: true },
  ],
  aiEnabled: true,
  sentimentEnabled: true,
});
```

### curl

```bash theme={null}
curl -X POST https://api.nephia.cc/v1/keywords \
  -H "x-api-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
        "name": "figma",
        "refreshIntervalSeconds": 900,
        "globalCriteria": { "market": "fr", "terms": ["figma", "figma alternative"] },
        "sources": [
          { "source": "reddit", "enabled": true },
          { "source": "x", "enabled": true }
        ],
        "aiEnabled": true,
        "sentimentEnabled": true
      }'
```

<Note>
  `subjectRole` says what the keyword is **about**: `own` for your own brand or product
  (the default), `competitor` for somebody else's, `topic` for a problem or a category
  rather than a product. It changes nothing about what gets polled: it is what a reply
  draft reads to decide whose voice it writes in.
</Note>

<Note>
  Keyword bodies are **camelCase**, unlike the rest of this API. A keyword is the one object
  you round-trip (read it, change a field, send it back), so its body is spelled the way its
  response is. See [Overview](/api-reference/overview).
</Note>

A new keyword starts empty until its Sources are polled. Add `backfill: true` to the body
above and each Source is searched once immediately, at one tick per Source, so the next
step answers with content straight away. See [Day-one backfill](/keywords#backfill).

## 4. Read the mentions

One read across every Source and every keyword on the Account, newest first. Free.

```ts theme={null}
const { mentions } = await client.mentions.list({ limit: 50 });

for (const m of mentions) {
  console.log(m.source, m.sentiment, m.intent, m.title, m.url);
}
```

```bash theme={null}
curl "https://api.nephia.cc/v1/mentions?limit=50" \
  -H "x-api-key: YOUR_API_KEY"
```

Each mention carries the `keyword` it came from and what was read into it: `sentiment`,
`intent`, your agent step's answer under `agent`, the marks a rule put on it, and, on
`GET /v1/keywords/{id}/results`, the `bucket` it was sorted into. Narrow the read to one
keyword with `?keyword=<id>`.

Add a `webhookUrl` to the keyword and each match is **delivered** to your endpoint as it is
found instead of waiting to be polled. See [Webhooks](/webhooks).

## 5. Add more Sources

A keyword runs on every Source you add to its `sources`: Reddit, X, YouTube, Bluesky,
Hacker News, RSS, and [AI answers](/sources/ai-answers), which tracks what ChatGPT, Gemini
and Perplexity say about you. Watching a clothing brand or sourcing resale?
[Vinted](/sources/vinted) is a first-class Source too, with observed price history and
market statistics on top of its listings.

## Next steps

* [SDK (Node.js)](/sdk): typed client, `mentions` and `keywords` included
* [Authentication](/authentication) — key management and headers
* [Credits](/credits) — per-endpoint costs
* [Limits](/limits): request quota and plan entitlements
* [Sources](/sources/x): per-Source coverage and criteria ([Reddit](/sources/reddit), [Youtube](/sources/youtube))
* [Keywords](/keywords): everything a keyword carries, and its lifecycle
* [API Reference](/api-reference/overview) — full endpoint list


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