Skip to navigation
aVenture APISearch and IdentifyNatural Search

Find People With Natural Language

View as Markdown

Turns a plain-English people search into a structured PersonFilter, runs it as a regular people search, and returns both how the query was interpreted and a ranked page of matching people. Broad role, employer, work-history, and profile requests use person semantic search. Explicit filter fields are hard constraints: they override planner values, while the planner fills fields left unset.

Authentication

AuthorizationBearer

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

Query parameters

permitMonogrambooleanOptional
When false, generated monogram pictures are stripped from person rows.
pageintegerOptional>=0Defaults to 0

Zero-based page index (0..N)

sizeintegerOptional>=1Defaults to 20
The size of the page to be returned
sortlist of stringsOptional

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Request

This endpoint expects an object.
searchobjectRequired

The plain-English search request and the search method to use.

filterobjectOptional

Explicit people constraints. Caller-supplied fields override planner values; the planner fills only fields left at their canonical defaults.

Response headers

X-Aventure-Search-Cache-ModestringOptional

Cache policy this search ran under: use, bypass, or refresh. Explicit fresh modes require private-data access; automatic date freshness can select refresh for any caller.

X-RateLimit-LimitintegerOptional

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

X-RateLimit-RemainingintegerOptional

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

X-RateLimit-ResetintegerOptional

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

Ranked person matches for the interpreted query.
interpretationobject
Structured interpretation used to run the people query.
investmentlist of objects
Personal investment participation supporting the returned people. Firm portfolio activity is never attributed to employees. Empty for other question intents.
personLeadboolean
Whether people are the confirmed requested focus of this search.
profilelist of objects

aVenture people resolved or filed from web-discovered LinkedIn profiles whom no returned person matches, grouped by named in query order. A search that has not run yet runs only for a signed-in subscriber with layer=web.

resultobject
Page of matching people.
searchRequestIdstring or nullOptionalformat: "uuid"
Id of this search's stored record. Null when the search was not recorded.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required 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