Feeds

Connect a feed

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.

POST
/v1/feeds
AuthorizationBearer <token>

API key minted via POST /v1/api-keys (format mk_live_...)

In: header

urlstring

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.

Length4 <= length <= 500
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.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.mentio.dev/v1/feeds" \  -H "Content-Type: application/json" \  -d '{    "url": "string"  }'
{
  "id": "string",
  "url": "string",
  "title": "string",
  "connectedAt": "string",
  "readingSince": "string",
  "auth": {
    "type": "cookie"
  },
  "health": {
    "status": "ok",
    "reason": "login_required",
    "detail": "string",
    "failures": 0,
    "since": "string"
  },
  "stats": {
    "lastPolledAt": "string",
    "emptyPolls": 0
  }
}
{
  "id": "string",
  "url": "string",
  "title": "string",
  "connectedAt": "string",
  "readingSince": "string",
  "auth": {
    "type": "cookie"
  },
  "health": {
    "status": "ok",
    "reason": "login_required",
    "detail": "string",
    "failures": 0,
    "since": "string"
  },
  "stats": {
    "lastPolledAt": "string",
    "emptyPolls": 0
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "retryAfterSeconds": 0
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "retryAfterSeconds": 0
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "retryAfterSeconds": 0
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "retryAfterSeconds": 0
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "retryAfterSeconds": 0
  }
}