RoboLedger: Information Blocks

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.

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

Request

  • Base URL: https://api.robosystems.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/bind-text-block
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

graph_idstring required

Headers

Idempotency-Keystring nullable

Request body

document_idstring required

Platform Document to bind (see list-documents).

section_idstring nullable

Slugified heading id of one section to bind (the section ids search-documents returns); omit to bind the whole document.

structure_idstring required

Disclosure Structure the text block belongs to — must be block_type='regulatory_disclosure' with a text-block concept_arrangement (text_block / levelN_textblock).

element_idstring nullable

Disclosure element to tag the text to (id form).

element_qnamestring nullable

Disclosure element qname (e.g. 'acme:SignificantAccountingPoliciesTextBlock') — exactly one of element_id / element_qname.

period_startstring date required

Reporting period start the narrative covers (duration fact).

period_endstring date required

Reporting period end.

entity_idstring nullable

Entity the fact belongs to, by id; omit for the group parent.

Response

Successful Response

operationstring required

Kebab-case operation name

operationIdstring required

op_-prefixed ULID for audit and SSE correlation

status'completed' | 'pending' | 'failed' required

Operation lifecycle state

atstring required

ISO-8601 UTC timestamp

createdBystring nullable

User ID that initiated the operation

idempotentReplayboolean

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

Changes

No recorded changes to this operation across all 1 revision of this API.