OverviewPlatformsAPI Reference

Introduction

Every Rumoro endpoint, generated from the OpenAPI document the API serves.

Send every request to this base URL.

https://api.rumoro.dev/v1

Authenticate with a Bearer API key from the dashboard, or an OAuth token from an MCP sign-in.

import { createRumoro } from '@rumoro-dev/sdk';

const rumoro = createRumoro({ apiKey: 'ref_...' });
await rumoro.listKeywords();

These pages are built from the API's own OpenAPI document, which also validates requests. Each page's playground sends real requests to your workspace, so explore with a read key.

Start with Keywords and Mentions, or read Conventions. Slack, Telegram and delivery-log retries have their own pages.

Was this page helpful?

Create a keyword

Starts monitoring a word or phrase. Matching, scoring and delivery start with the next poll. A workspace with balance can have up to 500 keywords, each costing $5 a month, taken from the balance day by day. `matching` narrows what counts as a match, with required and excluded terms, excluded authors and case, before anything is stored, so rejected posts are never billed. `context` is a sentence only this keyword's classifier reads. `cap` limits matched mentions per month. At the cap the keyword stops matching until the 1st of next month (UTC) or until you raise the cap, and its daily charge continues.