Suggest entity relationships

View as Markdown

Semantic suggestions for this slot only. NOT a completeness signal. Each candidate is a hypothesis — verify with web search before writing. exhaustive is always false. See coverage for the remaining details and the owning read that proves each.

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.

includePrivatebooleanOptional

Whether to include private completion coverage when the caller has private-visibility authority.

Response

OK
coveragelist of objects

Per-entity completion-floor coverage of every other detail, with the owning read and how to obtain each gate. Sourced from the completion-gate coverage projection.

exhaustiveboolean

Always false. These suggestions are a non-exhaustive hypothesis set; the agent must still verify each candidate and consult coverage for everything else.

slotstring
The single enrichment slot these candidates cover.
suggestionlist of objects

Advisory candidate hypotheses for this slot, ranked by semantic score. Empty means no embedding neighbors; it is never a claim that the slot is complete.

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