OverviewAPI Reference
Auth

Introspect the credential

The workspace this credential acts on, how the request authenticated (an API key, an OAuth access token from an MCP sign-in, or the dashboard session), whether it may write, and for a key its id and expiry. Run it first: a read key answers 403 read_only_key on every write, and a wrong workspace is the classic scripting mistake.

GET
/v1/whoami

Authorization

AuthorizationBearer <token>

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

In: header

Response Body

application/json

application/json

curl -X GET "https://api.mentio.dev/v1/whoami"
{
  "workspace": {
    "id": "string",
    "name": "string"
  },
  "auth": {
    "kind": "api_key",
    "scope": "read",
    "apiKeyId": "string",
    "expiresAt": "string"
  },
  "user": {
    "id": "string",
    "email": "string",
    "name": "string"
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "retryAfterSeconds": 0
  }
}

Brand against competitors GET

Every keyword matched in the window with its counts and its share of brand plus competitor matches; topic keywords are counted but stay out of the split. The window is `range` (7d, 30d, 90d, 365d, ending today) or `from` and `to`, cut into days in `timezone` (UTC by default); `keywordIds` and `platforms` narrow it; `compare=true` adds the period of the same length right before it. Time axis is the publish date.

Get the workspace filters GET

The noise rules applied to every keyword before a mention is stored: excluded terms and authors, excluded GitHub repositories, and the subreddits Reddit posts may (or may not) come from. A post they reject is never classified, delivered or billed. Keyword-level rules live on each keyword (`matching`); both apply.