Skip to navigation

Search Companies, People, and News Together

View as Markdown

Searches entities, people, and news in one request. Only the auto and keyword modes are accepted; other modes and sort are rejected. Omitted body defaults are the aventure.vc search page’s request (suppress non-operating entities, 10 people, 4 news); the page also sends layer=synthesis, layer=web, and cacheMode use, so a client sending that request gets the page’s result. Scope interpretations report execution; unsearchable scopes carry provenance.rejection; layer=synthesis adds a cited answer and relatedQuery. SSE opens with admitted after metering, settled has all scopes, revised adds pendingWebQuery results and synthesis without moving settled rows, complete is terminal; ids are revision:request-uuid from 0. JSON Last-Event-ID reads the exact retained terminal revision with the original request and caller, never searching on refusal. SSE resumes retained state; only SSE can retry an admitted failed answer. X-Aventure-Search-Resume: only refuses a missing continuation. Disconnects do not cancel admitted work. Incomplete SSE snapshots end in error; terminal failures carry disposition=TERMINAL. Headerless signed-in JSON with web waits for discovery and files minimum profiles. Full research is admitted separately under the caller’s search setting and plan allowances, including late filings.

Authentication

AuthorizationBearer

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

Headers

Last-Event-IDstringOptional
Read this full SSE event id without searching.
X-Aventure-Search-ResumestringOptional

Send only with Last-Event-ID to resume an earlier search stream; if it cannot be resumed, the request fails instead of starting a new search.

X-TierstringOptional

Send batch to run language-model steps on the lower-priority background tier; omit for live requests.

Query parameters

includePrivatebooleanOptional

Send false for the aventure.vc search page’s public view, or omit it for your default view, which already includes private fields when your account may see them. Never send true: it adds nothing and answers 403 without that permission.

pageintegerOptional>=0

Zero-based page index (0..N)

sizeintegerOptional>=1
The size of the page to be returned
layerlist of enumsOptional

Repeat to add layers. Synthesis cites this response’s public entity records, passages, and news; other layers enrich entities while people and news run alongside.

Allowed values:

Request

This endpoint expects an object.
querystringRequired>=1 character

Plain-English search request.

answerModelstring or nullOptional

Optional supported model id for the written answer, which also supplies the page heading, title, and description. Leave the field out for the server’s model; a value that is not a supported model id answers 422.

cacheModeenumOptional

Cache policy. use reuses earlier search work; bypass and refresh compute fresh results and are honored only for accounts with private-data access.

Allowed values:
entityFilterobjectOptional

Explicit entity constraints for the entity scope only, as on POST /v1/search/natural/entities: caller-supplied fields override planner values. The person and news scopes ignore it. Terminal entities are suppressed only for category discovery; named and relational searches keep them, even with true. Explicit suppressNonOperating=false always includes them.

freshnessenumOptional

auto refreshes date-sensitive queries before cache admission; cached permits ordinary cache reuse. Explicit admitted bypass or refresh wins.

Allowed values:
modestringOptional

Search strategy to run. Defaults to auto: the fast name layer runs first (a single-token query as keyword search, a multiword query as an exact normalized name) and the language-model planner runs only on a miss, so name lookups never pay for planning. Any other value forces exactly that strategy: exact and keyword skip planner model resolution and its rate limit. Entity and person natural-search take every value but hybrid; news and federated search accept only auto and keyword; content search accepts auto, keyword, semantic, and hybrid (semantic and hybrid only for one entity’s or person’s content).

modelstring or nullOptional

Optional supported model id for planning the search. Leave the field out for the server’s model; a value that is not a supported model id answers 422.

modelCatalogRevisioninteger or nullOptional

Model catalog revision this search uses for its model defaults and inference policy; null reads the current revision. Callers without private-data access always read the current revision. An unknown revision returns 404.

newsSizeinteger or nullOptional

News scope page size; defaults to 4, matching the aventure.vc search page, under the same page-size cap. Explicit null uses the size query parameter.

personSizeinteger or nullOptional

Person scope page size; defaults to 10, matching the aventure.vc search page, under the same page-size cap. Explicit null uses the size query parameter.

reasoningEffortstring or nullOptional

Optional reasoning effort for every model call this search makes: the query planner and the synthesis answer. Each call sends the nearest level its model supports, the lower one on a tie. Accounts without private-data access are capped at medium; higher values are lowered.

searchCatalogRevisioninteger or nullOptional

Search catalog revision this search uses for its global search policy and vocabulary; null reads the current revision. Callers without private-data access always read the current revision. An unknown revision returns 404.

sourceNewsIdinteger or nullOptional>=1

The stored aVenture news article this search started from. Its approved public Company and Business Line mentions lead the entity scope as subjects in mention order. An unknown or non-public article, or one without such mentions, keeps the ordinary headline search. Other scopes and answer generation are unchanged.

tenantPolicyRevisioninteger or nullOptional

Runtime policy revision this search uses for the serving deployment’s execution budgets; null reads that deployment’s current revision. Callers without private-data access always read the current revision. An unknown revision returns 404.

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 matches across every federated record type.
entityobject

Canonical entity natural-search result.

entityDetaillist of objects

Public detail for Product/Service rows on the entity result page, in search rank order. Other entity types are not hydrated.

newsobject
Page of news results from keyword search.
newsEntityMentionlist of objects

Public entities each news row on the page links to, in news page order; a row with no public entity link has no entry.

personobject

Canonical person natural-search result.

personDetaillist of objects

Public detail for people on the person result page, in search rank order, with at most two public entity associations per person; person address and URL enrichment is omitted.

personLeadboolean

Whether people lead this page: the query names a person, a web-found person’s profile shows, or the query asks for people by a search catalog people term.

provenanceobject
Requested and executed strategy for each search scope.
qualifierobject or nullOptional

A prompt with rewritten queries offered beside a broad query’s results, from the search catalog revision the search read; null when no qualifier rule matches.

sectionlist of stringsOptionalRead-only

Result sections from most to least relevant. People lead when personLead is true and come last otherwise. An executed entity type scope leads only when all its expanded types select one section. Remaining sections follow their best entity row’s rank, then missing sections follow in Companies, Other Organizations, Products and Services, Investment Firms, Funds order. Legacy company and investor aggregates are not emitted.

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