Skip to main content
GET
Get Suggestion

Authorizations

api_key
string
header
required

Query Parameters

oId
string
required

The suggestion oId to preview. Get this from suggestion/list.

Example:

"esug_abc123"

includePreview
boolean
default:true

When true (default), also returns the rendered preview: for 'add' the full proposed new entity, for 'refine' the entity as it would look after the change (plus the current entity to diff against). Set to false for a fast metadata-only fetch that skips preview generation.

includeEvidence
boolean
default:false

When true, also returns the supporting events/findings that generated this suggestion (the 'why'). Defaults to false.

includeDiff
boolean
default:false

When true, also returns diffChunks — before/after diff chunks for the proposed change. For entity refine suggestions these are field-level diffs of the current entity vs the previewed result; for doc-update suggestions they are anchored hunks validated against the doc, each with a clean/stale/unverified status. Defaults to false to keep responses small.

Response

The suggestion detail (and preview, unless skipped)

_metadata
object
required
data
object
required