Information Block

post/extensions/roboledger/{graph_id}/operations/information-block

One section of a report read whole — the expensive call: rows in presentation order with the consolidated value per period column, the same rows broken out by the section's own axes, the axes with the members that carry facts, every total's calculation children with a footing check, and the section's text blocks. Member breakdowns and period columns are kept most-reported / most-recent first up to a response budget; a row is never left blank by a cut, and members_omitted / periods_omitted say what was. A block longer than max_rows is truncated; pass its next_offset as offset for the next page. Take block from disclosures. Same resolution as disclosures: ticker or report_id on shared-repo graphs, report_id on tenant graphs. On a tenant graph this reads the section as the ledger's report holds it; get-information-block returns one authored block's envelope with its rules and verification.

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
`ticker`optional	string	Company ticker. On shared-repository graphs (SEC) it resolves the latest matching filing when report_id is not given; ignored on tenant graphs.
`report_id`optional	string	Specific report identifier. Required on tenant graphs; on SEC, optional when ticker is given.
`fiscal_year`optional	integer	Narrow auto-resolution to this fiscal year focus
`period_type`optional	string	Which forms auto-resolution considers: annual (10-K / 20-F / 40-F, the default) or quarterly (10-Q as well)
`block`required	string	The block id from disclosures (a role name or its last segment also resolves)
`periods`optional	string[]	Period keys to keep, from a previous call's columns. Default keeps the budgeted set, year and balance columns first on an annual form.
`member`optional	string	Keep only breakdowns whose member key contains this text (a segment name)
`max_rows`optional	integer	Cap on presentation rows (default 400)
`max_members`optional	integer	An explicit cap on member breakdowns, instead of the response budget
`offset`optional	integer	Rows to skip: the next_offset a truncated response returned

Example request

curl

curl -X POST "https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/information-block" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "block": "string"
}'

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

InformationBlockResponse

Command-specific result payload

InformationBlockResponse fields

Field Type Description

graph_idrequired string

report_idrequired string

resolved_reportoptional

ResolvedReportInfo

Information about the auto-resolved report.

ResolvedReportInfo fields

Field	Type	Description
`report_id`required	string
`form`optional	string
`filing_date`optional	string
`fiscal_year`optional	integer
`fiscal_period`optional	string

blockrequired object

columnsoptional object[]

axesoptional object[]

rowsoptional object[]

row_countoptional integer

truncatedoptional boolean

offsetoptional integer

ancestorsoptional object[]

next_offsetoptional integer

calculationoptional object[]

textoptional object[]

noteoptional string

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