Skip to navigation
aVenture APICompaniesEntity Classifications

Suggest Classifications for a Company

View as Markdown

Returns ranked tag and standard industry code suggestions for the company, based on similar companies. mainProduct is never suggested, and an empty array means no similar company suggests anything. Requires sign-in; a company that is not public returns 404.

Authentication

AuthorizationBearer

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

Path parameters

entityIdstringRequiredformat: "uuid"

Entity id (UUID).

Query parameters

sizeintegerOptional

Maximum suggestions to return; default 12, maximum 50.

limitintegerOptionalDeprecated
Deprecated alias for size.

Response headers

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
alreadyJoinedboolean
True when the entity already has this classification, current or historical.
classificationobject
Suggested classification tag or standardized classification code.
rankinteger

One-based rank within this suggestion response.

scoredouble

Composite embedding similarity score; larger values rank higher.

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