Developers
Mentionwell API
Last updated
Mentionwell is a headless product. Every capability — pull articles, push articles, manage sites, run AEO scans — is available through the API, the SDK, the CLI, or an MCP server. Pick the surface that matches the workflow.
Pick your surface
| Surface | Use when | Auth |
|---|---|---|
| REST API | You’re building from any language; you want full control. | Bearer reader key (per-site) or PAT (account-wide) |
| mentionwell SDK | You’re in Node / TypeScript and want typed loaders. | Bearer reader key |
| CLI | You’re wiring Mentionwell into a project for the first time, or running operational tasks from a terminal. | PAT |
| MCP servers | You want your AI coding agent (Claude / Cursor / ChatGPT) to drive Mentionwell directly. | None (docs) or PAT (account) |
| Webhooks | You want Mentionwell to push articles to your endpoint on publish. | HMAC-SHA256-signed payloads |
Quickstart
# 1. Get a reader key for your site
curl https://app.mentionwell.com/v1/articles \
-H "Authorization: Bearer mw_read_..."
# 2. Or use the SDK
npm i mentionwell
import { mentionwell } from 'mentionwell';
const articles = await mentionwell({ apiKey: process.env.MENTIONWELL_API_KEY }).articles.list();
# 3. Or wire everything end-to-end
npx mentionwell-cli init Endpoint summary
GET /v1/articles— paginated article list with cursor.GET /v1/articles/{slug}— full article (HTML + Markdown + JSON-LD).GET /v1/articles/{slug}.md— markdown mirror.GET /v1/sites/{slug}/feed.xml— RSS.GET /v1/sites/{slug}/feed.json— JSON Feed.GET /v1/sites/{slug}/sitemap.xml— sitemap.GET /v1/sites/{slug}/llms.txt— AI crawler manifest.POST your.site/hook— HMAC-signed webhook fired on article publish.