Today's brief
GET /api/v1/brief
What needs a person today. With a playbook applied (apply_playbook; see list_playbooks) it is that playbook's brief: a ranked list of what is READY for that persona, each item with the quote, the link, how old it is, why it is ready (a plain explanation built from the post's typed signal) and the next actions; grouped by client or by what keeps coming up where the playbook says so. For a playbook about target accounts (gtm) the list is built from the conversations found for the workspace's accounts (import_accounts), each item naming its `account`. Pass playbook to try another without applying it, e.g. get_brief with playbook=gtm. The brief is computed from stored signal data: no model is called and it costs nothing to view. Without a playbook: open mentions ranked by urgency, each with the AI's one-line reason. Either way: how many are open per project and how many arrived in the last 24 hours. Start here when asked what people are saying about a brand or who to write to.
Any API key or OAuth token, or a signed-in member.
Parameters
| Name | Type | Description |
|---|---|---|
projectquery |
string | Only this project. |
limitquery |
integer 1–50 |
How many mentions to return (default 10; with a playbook, default is the playbook's size). |
playbookquery |
string | A playbook id (a built-in such as founders, agencies, product-marketers, developer-relations or gtm, or one of your own) to build the brief with instead of the one applied. |
Returns
{ data: { playbook, title, summary, counts, ready: Item[], groups, open, new_24h, projects } } with a playbook; { data: { playbook: null, open, new_24h, projects, mentions } } without
Example
curl "https://sniffington.com/api/v1/brief" \
-H "Authorization: Bearer $SCOUT_API_KEY"