Skip to navigation

Get Research Snippet

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

Authentication

AuthorizationBearer

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

Path parameters

entityIdstringRequiredformat: "uuid"

Entity id (UUID).

snippetIdintegerRequired
Research snippet id.

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
entityIdstringformat: "uuid"

Entity id (UUID)

idinteger
textstring
textTypestring
complianceobject or nullOptional

Character and word counts for this snippet and whether it meets its type’s length and paragraph rules; null when not checked.

publicSourceobject or nullOptional

Published page behind this value, read from the provenance event that wrote it; absent for internal sources.

updatedAtdatetime or nullOptional

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