Contents

API reference / Projects

Create a project

POST /api/v1/projects

create_project Write MCP tool

Creates a project with 'My brand' and 'Competitors' keyword groups and the default categories. Pass keywords/competitors to start searching right away.

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

Request body

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

NameTypeDescription
name required string
1–80 characters
 Display name, e.g. the brand.
mode string mentions: track what people say about you. leads: find people describing a problem you solve.
One of: mentions leads
description string
up to 1000 characters
 What the brand is, in a sentence or two. The AI uses it to tell real mentions from namesakes.
audience string
up to 1000 characters
 Leads mode: who counts as a lead.
color string Hex colour.
icon string An emoji or short label.
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
window_days number
0.5–30
 Lookback per scan, in days.
backfill_days number
1–730
 Lookback for the first scan.
scan_every string Scan cadence, e.g. 24h, 6h, 1h. Omit for the workspace default.
timezone string IANA timezone, e.g. America/New_York.
paused boolean
settings object handles {platform: [..]}, team [..], domains [..], ambiguous {anchors, namesakes}, hashtags [..].
public boolean Publish a read-only public dashboard.
public_slug string URL slug for the public dashboard.
public_description string
up to 500 characters
 Shown on the public dashboard.
public_website string Link shown on the public dashboard.
keywords array of string Create project: keywords to start with (added to the 'My brand' group).
competitors array of string Create project: competitor names to start with (added to the 'Competitors' group).

Example

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