aVenture APISearch and identifySearch

Identify every company and person a page or screenshot names

View as Markdown
Reads a page (sourceUrl or sourceNewsId), a screenshot (multipart file part), or both, 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 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. Never creates records. Needs a signed-in user or the admin key and spends the same natural-search quota as POST /v1/lookup-jobs; reading a page or screenshot also needs a plan, sending mention does not. JSON body: {"sourceUrl":"https://techcrunch.com/2024/01/01/example"} or {"mention":[{"name":"Visa","mentionType":"COMPANY"}]}; multipart: a file part plus an optional JSON body part.

Authentication

AuthorizationBearer
Your aVenture API key (https://aventure.vc/settings/api-keys) or OAuth access token

Query parameters

includePrivatebooleanOptional

Also considers hidden and unpublished records; needs private-visibility authority. Without it, NO_MATCH covers only records you can see.

Request

This endpoint expects an object.
mentionlist of objectsOptional

POST /v1/lookup-mentions only: the companies and people a caller already read from a page or screenshot it keeps on its device, identified without either being sent. Send it alone, without sourceUrl, sourceNewsId, or a file. Any signed-in user may send it, with or without a plan.

sourceNewsIdinteger or nullOptional

aVenture news id of the article; an id that names no stored article is an error.

sourceUrlstring or nullOptional0-2000 characters

URL of the article; read from aVenture news when stored there, otherwise fetched.

Response headers

X-RateLimit-Limitinteger

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-Remaininginteger

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-Resetinteger

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.

mentionlist of objects
Each distinct name, in the order the source shows it.
sourceobject or nullOptional

The page read; absent when only a screenshot was sent.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
406
Not Acceptable Error
409
Conflict Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error