Skip to navigation

List People Similar to One Person

View as Markdown

Returns people similar to the person with this personId. Rows carry the person shape and per-row similarity provenance; load full detail through the person read endpoint. Stored rank is authoritative; photos break only contiguous equal-score ties. The Page total counts publicly readable people in the first 500 stored neighbors, independent of page size. Defaults to 20 rows; follow X-Next-Cursor only after an explicit more action. This endpoint does not support custom sorting. Any signed-in user may call this on every plan. The list is free: it never counts against the monthly record-view allowance, which charges only a separate full-detail view of one record.

Authentication

AuthorizationBearer

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

Path parameters

personIdstringRequiredformat: "uuid"

Person unique identifier (UUID)

Headers

X-Request-OriginstringOptional

Label naming which app or page sent the request; used only for usage metrics and does not change results.

Query parameters

permitMonogrambooleanOptional
Permit monogram fallback
pageintegerOptional>=0Defaults to 0

Zero-based page index (0..N)

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

Continuation from X-Next-Cursor; reuse the same person and size. A changed ranked roster returns 400; restart without cursor. Page is ignored with cursor.

Response headers

X-Next-CursorstringOptional

Continuation for the next person similarity page; absent on the last page

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

OK
contentlist of objectsOptional
emptybooleanOptional
firstbooleanOptional
lastbooleanOptional
numberintegerOptional
numberOfElementsintegerOptional
pageableobjectOptional
sizeintegerOptional
sortobjectOptional
totalElementslongOptional
totalPagesintegerOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
406
Not Acceptable Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error