---
title: "Connect a feed"
description: "Connect an RSS or Atom feed: a feed's address, or a page's (a forum, a community, a blog), in which case the feed the page advertises is used, else a usual address such as /feed or /rss. Every keyword of the workspace with readsWorkspaceFeeds (the default) reads these feeds: an item holding its term is one of its mentions, with its matching rules, billed like any mention. Each feed is read every hour; reading it is free. At most 500 a workspace. A new feed brings each reading keyword the newest 10 items of the last 30 days that hold its term, never as instant alerts. A feed the workspace reads already comes back with 200 (connecting is idempotent). A members-only forum answers `feed_login_required`: send it again with `auth` (a cookie or a header), stored encrypted and read for this workspace alone."
canonical: https://docs.mentio.dev/api/feeds/create-feed
markdown: https://docs.mentio.dev/api/feeds/create-feed.mdx
---

# Connect a feed

`POST /v1/feeds`

Connect an RSS or Atom feed: a feed's address, or a page's (a forum, a community, a blog), in which case the feed the page advertises is used, else a usual address such as /feed or /rss. Every keyword of the workspace with readsWorkspaceFeeds (the default) reads these feeds: an item holding its term is one of its mentions, with its matching rules, billed like any mention. Each feed is read every hour; reading it is free. At most 500 a workspace. A new feed brings each reading keyword the newest 10 items of the last 30 days that hold its term, never as instant alerts. A feed the workspace reads already comes back with 200 (connecting is idempotent). A members-only forum answers `feed_login_required`: send it again with `auth` (a cookie or a header), stored encrypted and read for this workspace alone.

## Body

- `url` (required): A feed's address (https://forum.example.com/posts.rss), or a page's (https://forum.example.com): the feed the page advertises is used.
- `auth`: A sign-in for a members-only feed: a cookie, or one header. Write-only: stored encrypted, sent to the feed's own site alone, never shown again. A feed with a sign-in is read for this workspace alone.

## Responses

- 200: The workspace reads this feed already
- 201: The feed, connected now
- 400: feed_login_required: a sign-in wall, send auth. feed_login_expired: the auth sent does not read it. feed_unreadable: no feed there, or the site blocks readers (the message says which).
- 401: Missing or invalid API key
- 409: feed_limit_reached: the workspace reads 500 feeds already
- 429: More than 30 feeds checked in a minute
- 503: feed_auth_not_configured: a sign-in was sent and this deployment cannot store one

Full schemas: https://api.mentio.dev/v1/openapi.json. Conventions: https://docs.mentio.dev/conventions.mdx