Deprecated: Identify Every Company and Person a Page, Screenshot, or PDF Names
Deprecated: send the same request to lookupMentions (POST /v1/lookup/mentions), adding scheduleEnrichment=true to keep queueing research on the records it adds. Reads a page (sourceUrl or sourceNewsId), a recorded document such as an email (sourceDocumentId, sent alone), a screenshot or PDF (multipart file part), or a page and screenshot, lists every company, organization, investor, and person it names, and identifies each one as POST /v1/lookup would, with the page as its source. A PDF’s link annotation targets and printed URLs identify as URLs, and names from every readable text chunk identify as mentions under the same mention cap; names left out set truncated. A page fetched from sourceUrl first lists its own site’s company, looked up by that site’s URL, unless the site is a news outlet, a shared platform such as LinkedIn, or aVenture; when no record holds that site, it is added from the name the site declares, as POST /v1/lookup adds a URL. A caller that read the names itself sends them as mention instead, alone, so neither page nor screenshot leaves it. Answers within seconds: a name still identifying when the time is up carries failureReason instead of identification; send it alone to POST /v1/lookup. Each NO_MATCH name whose own site a web search finds, and whose live page names it, is added as a new unpublished record, queued for research as scheduleEnrichment says, and returned as shell; adding it spends no research unit, and a name not added carries shellDetail saying why. Without Prefer: respond-async, JSON and text answers await filing within the live deadline. Only callers sending Prefer: respond-async release the identifications with filing pending in a lookup job; poll filing.statusUrl and merge its mention rows by mentionType and name. The event stream sends each identification immediately and each committed shell before complete. Needs a signed-in user. Each name spends one name-identification quota slot, as POST /v1/lookup does; reading a page, screenshot, or PDF also spends one natural-search slot and the free daily lookup allowance (20 name lookups per UTC day), sending mention does neither. JSON body: {“sourceUrl”:“https://techcrunch.com/2024/01/01/example”} or {“mention”:[{“name”:“Visa”,“type”:“COMPANY”}]}; multipart: a file part plus an optional JSON body part.
Authentication
Your aVenture API key (https://aventure.vc/settings/api-keys) or OAuth access token
Headers
Send respond-async to release identifications before shell filing completes; poll filing.statusUrl.
Query parameters
Omitted or true queues research on each record this lookup adds; false adds it without queueing research. Its logo import starts either way, and a matched record is never queued here.
Request
POST /v1/lookup/mentions only: true answers each name with only its name, mentionType, failureReason, and identification status, stage, match, officialUrl, and detail: no entity or person rows and empty candidate and duplicate lists. Defaults to false, the full answer.
Id of a stored source document whose text is the article; send it alone. Only POST /v1/lookup/mentions reads it, and only for accounts with editing rights.
aVenture news id of the article; an id that names no stored article is an error.
URL of the article; read from aVenture news when stored there, otherwise fetched.
Response headers
Requests allowed per client IP in the current rate-limit window.
Requests left before the tightest applicable rate-limit bucket rejects.
Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.
Response
Every mention as canonical JSON or complete compact text/plain.
Each distinct name: the page’s own company first, then the order the source shows them, with news outlets and the page’s bylined authors last.
Present only for callers that sent Prefer: respond-async. Identifications are settled but shell filing is pending. Poll statusUrl until the lookup job completes; merge its filing outcomes by mentionType and name.
True when the page names more than this answer holds: more names than one live lookup reads, or a body longer than the read limit. A lookup job with maxNames reads every name.