Contents

API reference / Projects

Suggest a project from a website

POST /api/v1/projects/suggest

suggest_project Write

Reads the home page and returns a name, a description, keywords ranked best first, competitors, the brand's own handles and what it may be confused with. The keywords include up to three of kind `topic`: category phrases to watch under Topics, not as brand keywords. `picked`, `picked_competitors` and `picked_topics` together are the part that fits the plan's keyword limit. Nothing is created.

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

Request body

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

NameTypeDescription
url required string
3–300 characters
The brand's website, e.g. acme.com.

Example

curl -X POST "https://sniffington.com/api/v1/projects/suggest" \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/hooks/social-scout"}'