aVenture APIEntity Research

Get research snippet

View as Markdown
Returns one research snippet for an entity. Public reads omit private provenance fields.

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.
snippetIdintegerRequired
Research snippet id.

Response

OK
entityIdstringformat: "uuid"
Canonical entity UUID
idinteger
isCurrentboolean

Current row. The live snippet for its type; demoted historical rows read only with includePrivate.

isPrimaryboolean
Primary row among the current snippets of its type.
textstring
textTypestring
visibleboolean

Whether the snippet appears in default reads. Admin/private reads (includePrivate) also return hidden rows.

complianceobject or nullOptional

Derived character/word counts and governed-contract compliance for this snippet row; null when not evaluated.

createdAtdatetime or nullOptional
updatedAtdatetime or nullOptional

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