Skip to main content
POST
Check Resource Drift

Authorizations

api_key
string
header
required

Body

application/json

Resource to check plus the propose flag

resourceOId
string
required

The resource (doc) oId to check. Get this from /resource/list or /resource/search.

Minimum string length: 1
Example:

"rs_1234567890"

propose
boolean
default:false

When true and the check finds material drift, persist the proposal as a real suggestion on the review rails (visible in the suggestions inbox and via /suggestion/list, /suggestion/accept). When false (default), the check is a pure diagnostic — nothing is created.

Response

The drift check verdicts and optional proposal

_metadata
object
required
material
boolean
required

True when the doc warrants an update from the library's state

skippedReason
string | null
required

Why the check was skipped (doc unreadable, no linked entities, unchanged since last check) — null when it ran

assessments
object[]
required

Per-linked-entity phase-1 verdicts

proposal
object | null
required

The consolidated doc-update proposal when material

editHunks
object[] | null
required

Anchor-validated before/after edits for the doc: every anchor was located verbatim in the live document (unmatched ones are dropped), so they can be applied as-is. Null when the model returned none — a change amounting to a full rewrite has a proposal but no hunks.

suggestionOId
string | null
required

The persisted suggestion's oId when propose: true created one — pass it to /suggestion/get or /suggestion/accept

checkedAt
string | null
required
tokensUsed
number
required