Bind Text Block

post/extensions/roboledger/{graph_id}/operations/bind-text-block

Bind a platform Document (markdown) — or one of its sections — to a disclosure element as a Nonnumeric text-block fact. The document stays the editable source of truth; the fact snapshots its text into a standing 'disclosure' FactSet with document provenance (document_id + section + content_hash). Re-binding the same element and period replaces the fact and refreshes the hash. Reports generated afterward snapshot the standing set, so filed reports are immutable against later document edits.

Idempotency: supply an Idempotency-Key header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.

Authentication

Authenticate in any one of these ways — not all of them:

API key in the X-API-Key header.
Bearer token in the Authorization header.

Path parameters

Name	Type	Description
`graph_id`required	string	Graph Id

Header parameters

Name	Type	Description
`Idempotency-Key`optional	string	Idempotency-Key

Request body

Required, application/json.

Field	Type	Description
`document_id`required	string	Platform Document to bind (see list-documents).
`section_id`optional	string	Slugified heading id of one section to bind (the section ids search-documents returns); omit to bind the whole document.
`structure_id`required	string	Disclosure Structure the text block belongs to — must be block_type='regulatory_disclosure' with a text-block concept_arrangement (text_block / levelN_textblock).
`element_id`optional	string	Disclosure element to tag the text to (id form).
`element_qname`optional	string	Disclosure element qname (e.g. 'acme:SignificantAccountingPoliciesTextBlock') — exactly one of element_id / element_qname.
`period_start`required	string (date)	Reporting period start the narrative covers (duration fact).
`period_end`required	string (date)	Reporting period end.
`entity_id`optional	string	Entity the fact belongs to; defaults to the primary entity.

Example request

curl

curl -X POST "https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/bind-text-block" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "document_id": "string",
  "structure_id": "string",
  "period_start": "2026-01-31",
  "period_end": "2026-01-31"
}'

Responses

200 Successful Response

Field Type Description

operationrequired

string

Kebab-case operation name

operationIdrequired

string

op_-prefixed ULID for audit and SSE correlation

statusrequired

string

Operation lifecycle state

One of: completed, pending, failed

resultoptional

BindTextBlockResponse

Command-specific result payload

BindTextBlockResponse fields

Field	Type	Description
`fact_id`required	string	The Nonnumeric Fact created.
`fact_set_id`required	string	Standing 'disclosure' FactSet holding the fact.
`structure_id`required	string
`element_id`required	string
`document_id`required	string
`section_id`optional	string
`content_hash`required	string	Full sha256 hex of the bound text (drift signal).
`characters`required	integer	Length of the bound text.
`period_start`required	string (date)
`period_end`required	string (date)
`replaced`required	boolean	True when a re-bind replaced this element's existing fact in the standing FactSet (content and provenance refreshed).

atrequired

string

ISO-8601 UTC timestamp

createdByoptional

string

User ID that initiated the operation (null for legacy callers)

idempotentReplayoptional

boolean

True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.

Default: false

Status	Meaning
400	Invalid request
401	Authentication required
403	Access denied
404	Resource not found
409	Idempotency-Key conflict — key reused with different body
422	Validation error
429	Rate limit exceeded
500	Internal server error