Suggest entity classifications

View as Markdown

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.

Authentication

AuthorizationBearer

User bearer token: Supabase or 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

entityIdstringRequiredformat: "uuid"
Canonical entity UUID

Query parameters

limitintegerOptional

Maximum suggestions to return; capped by the service.

Response

OK
alreadyJoinedboolean
True when the entity already has a current or historical matching join.
classificationobject
Suggested writable editorial tag or standardized classification code candidate.
creatableboolean
Whether a missing editorial tag value may be created with type plus name instead of tagId.
rankinteger

One-based rank within this suggestion response.

scoredouble

Composite embedding similarity score; larger values rank higher.

writableboolean
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