Skip to main content
POST
Create a news signal

Authorizations

Authorization
string
header
required

Account API key passed in the Authorization header

Query Parameters

account_id
string

Target account UUID. Required for staff callers; ignored for customer API keys.

Body

application/json
name
string
required

Short label, unique in the account. Name it after the question, e.g. 'Series B in fintech'.

Minimum string length: 1
use_cases
object[] | null
required

One to ten use-cases: the whole relevance definition. An article is relevant when it falls into at least one, judged on that use-case's own prompt.

Required array length: 1 - 10 elements
companies_list_id
string

WATCH shape: a companies list whose companies' news to read. Pass this OR queries, never both.

contacts_list_id
string

WATCH shape: a contacts list whose companies' news to read. Pass this OR queries, never both.

include_domains
string[] | null

DISCOVERY shape only: bare hostnames to trust, e.g. techcrunch.com. Omit for the whole web.

is_enabled
boolean

Defaults to true.

max_articles_per_query
integer<int32>

Articles judged per query per sweep: the cost dial, one credit per judged article. Omit for the default.

Required range: x >= 1
max_companies_per_sweep
integer<int32>

WATCH shape only: how many companies of the list to read per sweep. Omit for the default.

Required range: x >= 1
queries
string[] | null

DISCOVERY shape: short search themes, each run as its own search per sweep, finding companies you do not follow yet. Pass this OR a list id, never both.

search_keywords
string[] | null

WATCH shape only: narrow the search to company AND one of these topics. Omit to read everything stored for the company.

time_filter
enum<string>

How far back each sweep looks. Defaults to last_week.

Available options:
last_day,
last_week,
last_month,
last_3_months

Response

OK

id
string
required
is_enabled
boolean
required
kind
string
required

The kind, as List signals reports it and as a lead generation run takes it.

name
string
required
used_by_program_count
integer<int64>
required

Always 0 on creation: a signal runs only when a lead generation program picks it.