---
title: "Overview"
description: "What Rumoro does, how a post becomes a mention in your feed, and how to build on it."
canonical: https://docs.rumoro.dev/
markdown: https://docs.rumoro.dev/index.mdx
---

# Overview

What Rumoro does, how a post becomes a mention in your feed, and how to build on it.

Rumoro is social listening for developers and AI agents. You choose the words to watch, such as your product, your competitors or your field. Rumoro finds them on X, Bluesky, Hacker News, Reddit, GitHub, Stack Overflow, DEV, YouTube, LinkedIn, TikTok, Instagram and in the news, and in reviews on the App Store, Google Play, Trustpilot and Google. Each mention is scored for relevance, sentiment and intent. You read them in one feed, triage them, and send them wherever you work.

## From post to feed

1. **Find.** Rumoro checks each [platform](/platforms) on its own schedule and reads Bluesky live. A new keyword also gets recent posts from the last 30 days.
2. **Match.** Each post is compared with every keyword that covers its platform, using the keyword's rules.
3. **Score.** A model reads your company profile and rates the mention. You get relevance from 0 to 100, sentiment, intents like `buy_intent` or `complaint`, and a one-line note.
4. **Send.** Alert rules send relevant mentions right away, or in an hourly, daily or weekly digest, to Slack, Telegram, email or a signed webhook.

You pay for every matched mention, relevant or not. Rules send only relevant ones unless you lower `minRelevance` (0 sends everything). More in [How it works](/how-it-works).

## Ways in

<Cards>
  <Card icon="Code" title="REST API" description="Every operation over HTTP." href="/api" />
  <Card icon="Package" title="SDKs" description="Typed clients for TypeScript and Python." href="/sdks" />
  <Card icon="Terminal" title="CLI" description="Run any endpoint from your terminal, or stream new mentions." href="/cli" />
  <Card icon="Sparkles" title="MCP server" description="Let AI agents use Rumoro as tools." href="/mcp" />
  <Card icon="Webhook" title="Webhooks" description="A signed request for each mention or digest." href="/webhooks" />
  <Card icon="Bell" title="Alerts" description="Mentions in Slack, Telegram or email." href="/alerts" />
</Cards>

The SDKs, the CLI and the MCP server use the operations in the [OpenAPI document](https://api.rumoro.dev/v1/openapi.json), so fields have the same names everywhere.

## The model

| Resource | What it is | Reference |
| --- | --- | --- |
| Keywords | Terms you track (`brand`, `competitor`, `topic`), with their platforms, matching rules (required and excluded terms, excluded authors, case) and context for the classifier. | [/v1/keywords](/api/keywords/list-keywords) |
| Groups | Keywords grouped by customer, campaign or product. Each group can have its own company description and its own bill. | [/v1/groups](/api/groups/list-groups) |
| Filters | Workspace rules that drop noise, such as excluded terms, authors, GitHub repositories and subreddits. Dropped posts are never stored or billed. | [/v1/filters](/api/filters/get-filters) |
| Mentions | A post matched to a keyword, with its scores, your verdict and triage (`open`, `ignored` or `done`, assignee, snooze, note). | [/v1/mentions](/api/mentions/search-mentions) |
| Views | Saved mention filters. | [/v1/views](/api/views/list-views) |
| People | The authors behind mentions, with reach, profile, tags, notes and mutes. | [/v1/people](/api/people/list-people) |
| Segments | Saved people filters that are always up to date. | [/v1/segments](/api/segments/list-segments) |
| Alerts and channels | Rules that send mentions to Slack, Telegram, email or webhooks, right away or as digests. | [/v1/alerts](/api/alerts/list-alerts) |
| Attention | Hourly checks for spikes, negative turns, noisy keywords and failing channels. | [/v1/attention](/api/attention/list-attention) |
| Analytics | Five reports. Summary, series, breakdown, share of voice and reviews. | [/v1/analytics](/api/analytics/get-analytics-summary) |
| Company | Your description, use cases, competitors and guidelines. The classifier reads it, so it matters most for relevance. | [/v1/company](/api/company/get-company) |
| Members | Your team, roles and invitations. Any credential can read them. Changes need a signed-in owner or admin, in the dashboard or through OAuth. API keys can't change the team. | [/v1/members](/api/members/list-members) |
| Usage and billing | Balance, daily cost, billed keywords and matches. | [/v1/usage](/api/usage/get-usage) |
| API keys | `read` or `write` keys for one workspace, with an optional expiry. `GET /v1/whoami` tells you which key is calling. | [/v1/api-keys](/api/api-keys/list-api-keys) |

## Start here

- [Quickstart](/quickstart) creates a keyword, sets your company profile, searches and triages, in five calls.
- [Authentication](/authentication) and [Conventions](/conventions) cover keys, scopes, response shapes, ids and errors.
- [Alerts](/alerts) sends mentions to you. [Billing](/billing) explains the prepaid balance.
- Building with an agent? Connect the [MCP server](/mcp) or give it [llms.txt](/llms.txt).