Skip to main content
POST
Re-read an attached policy document into the editor

Authorizations

X-API-Key
string
header
required

API key for authentication

Headers

X-Organization-Id
string

Organization ID (required for session auth, optional for API key auth)

Path Parameters

id
string
required

Policy ID

Example:

"pol_abc123def456"

Body

application/json
versionId
string

Optional version ID whose attached document should be read. Omit to use the policy's current version.

Example:

"pv_abc123def456"

Response

201 - application/json
queued
boolean
required

True when a read of the attached document was queued. False when no read will happen — see reason.

Example:

true

versionId
object | null
required

The version the read targets, or null when the policy has no version to read into.

Example:

"pv_abc123def456"

reason
object | null

Null when the read was queued. Otherwise why it was not, so a caller never waits for text that is not coming: no_version / no_document (nothing to read), already_has_content (the version already has text), pending_approval or published_version (the target may not be written to), document_replaced (the attached file changed), queue_unavailable (the job could not be scheduled — retry).

Example:

null