aVenture APIEntity Similarity

List entities similar to one entity

View as Markdown
Requires one entity identity: id or slug (CLI: --entity-id or --entity-slug). Neither is individually required, but the request fails without one of them; id wins when both are sent. Returns similar entities by id or slug. Results include the entity list row and per-row similarity provenance; load full detail through the entity detail endpoints. Results are ordered by similarity score (highest first). Use relationshipType to filter by specific stored relationships (e.g., competitor). This endpoint does not support custom sorting.

Authentication

X-Client-Secretstring

Client secret for read-only service-to-service access (no writes)

Query parameters

idstringOptionalformat: "uuid"

Entity unique identifier (UUID) — at least one of id or slug required

slugstringOptionalformat: "^[a-z0-9_-]+$"<=255 characters

Entity URL-friendly identifier (slug) — at least one of id or slug required

relationshipTypestringOptional

Filter by stored relationship type, one of: acceleratorParticipant, acquirer, affinity, calculated, competingProductService, competitor, customer, fundManagerFirm, parent, productService, serviceProvider, similarCompany, spinOffFrom, successor.

typeRecordlist of stringsOptional
Optional entity typeRecord filter. Repeat to allow multiple entity types.
permitMonogrambooleanOptional
Permit monogram fallback
pageintegerOptional>=0Defaults to 0

Zero-based page index (0..N)

sizeintegerOptional>=1Defaults to 10
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.

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
406
Not Acceptable Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error