Identify Names in an Article
An article lookup reads one article, extracts every company and person it
names, and identifies each name as POST /v1/lookup would, with the article
as the source. It shares the lookup’s plan requirement.
To identify more names than an article job’s limit, or a list of names you
already hold, start a bulk lookup job instead.
Choose an Article Path
Use the first row when you need only the answers. Add scheduleEnrichment=true
when the article may name companies or people aVenture does not have yet and you
want each new record researched. Use --max-names when you want a bounded batch
of identifications and will continue the article yourself; that call answers
202 with a jobId you read at GET /v1/lookup/jobs/{jobId}.
- Send
POST /v1/lookup/mentionswith a body holdingsourceUrl,sourceNewsId, or both. AddscheduleEnrichment=trueto queue research on each record it adds. The call answers200with every name inmention. - To get the identifications before new records finish filing, also send
Prefer: respond-async. The answer then carriesfiling; read itsstatusUrluntil the job completes, and merge its filing outcomes into the names you already have. - Act on each entry in
mention. Every entry has thenameas the article writes it and amentionTypeofCOMPANY,PRODUCT_SERVICE, orPERSON:identificationis the lookup answer, read exactly as in Act on the answer.shellis set when the answer isNO_MATCHand the lookup filed a new record for the name, or found a record aVenture already holds for the subject’s website. It files one only when the article and the subject’s own live website both name it.shellholds the record’sentityIdorpersonId; whenenrichmentRunIdis present, it names the research run that fills in the profile. Filing it costs nothing.shellDetailsays, in one sentence, why no new record was filed for aNO_MATCHname.failureReasonreplacesidentificationwhen a name could not be identified. Send that name alone toPOST /v1/lookup.
Reading the article spends one natural-search call, and each name it identifies
spends one name-identification call, up to its per-article limit. The call
answers 402 and 429 under the same rules as a single lookup.
Example
Set ARTICLE_URL to the article’s address and look it up, queueing research on
new records:
Collect the ids from each matched mention’s match.owner and from each shell
without an enrichmentRunId, then queue research on the
ones worth updating.