Skip to navigation

Share a Search Answer

View as Markdown

Runs the query against public records and saves its answer under the supplied UUID. Reusing the UUID with the same query returns the original answer; a different query is rejected. The saved answer survives query-cache expiry and is readable without authentication. No result supplied by a caller is accepted.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
idstring or nullOptionalformat: "uuid"
Stable sharing UUID generated once and reused across retries.
querystring or nullOptional0-2000 characters

Plain-English query to run against public records and publish.

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

OK
publicationobject
Public search publication metadata.
resultobject
Federated entity, person, and news search result composed from each domain's canonical search result owner, with the strategy used for every scope.

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