Contents

API reference / Keywords

Add a keyword

POST /api/v1/projects/{project}/keywords

create_keyword Write MCP tool

Aliases catch other spellings, handles and domains; excluded terms skip posts that also contain them.

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

NameTypeDescription
project required
path
string The project's id.

Request body

JSON, sent with Content-Type: application/json.

NameTypeDescription
term required string
2–200 characters
The keyword, 2–200 characters.
aliases array of string
up to 10 items
Other spellings, handles or domains that count as the same thing (max 10).
excluded array of string
up to 10 items
Skip any post that also contains one of these (max 10).
case_sensitive boolean
sources array of string Sources to search. Omit for every source available.
One of: reddit linkedin x hn instagram github stackoverflow devto bluesky news youtube tiktok threads facebook appstore feeds jobs pages
languages array of string
up to 20 items
Only read posts in these languages: two-letter codes such as en, de, ja. Empty means every language; a post whose language can't be told is kept.
group_id integer or null Keyword group; omit for 'My brand'.
active boolean Inactive keywords keep their history but aren't searched.

Example

curl -X POST "https://sniffington.com/api/v1/projects/{project}/keywords" \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"term":"acme"}'