Suggest entity classifications
Default classification discovery path for enrichment agents. Returns ranked embedding-derived tag and standardized-code suggestions; empty array means no embedding neighbors. Create joins with the entity classifications create endpoint. A signed-in user is admitted for public entities; callers with private-visibility authority (admin key or ROLE_ADMIN) also resolve hidden/private entities, and includePrivate=true requires that authority, otherwise hidden/private entities 404.
Authentication
AuthorizationBearer
User bearer token: Clerk session JWT, Clerk OAuth access token, or Clerk personal API key
OR
X-API-Keystring
Admin API key for system-to-system write operations
OR
X-Client-Secretstring
Client secret for read-only service-to-service access (no writes)
Path parameters
entityId
Canonical entity UUID
Query parameters
limit
Maximum suggestions to return; default 12, maximum 50.
includePrivate
Include private/hidden entity suggestions when the caller has private-visibility authority (admin key or ROLE_ADMIN). Without that authority hidden/private entities 404.
Response
OK
alreadyJoined
True when the entity already has a current or historical matching join.
classification
Suggested writable editorial tag or standardized classification code candidate.
creatable
Whether a missing editorial tag value may be created with type plus name instead of tagId.
rank
One-based rank within this suggestion response.
score
Composite embedding similarity score; larger values rank higher.
writable
Whether this suggestion can be joined through the classification mutation endpoint.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
406
Not Acceptable Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error