Evaluate Rules for an Information Block

post/extensions/roboledger/{graph_id}/operations/evaluate-rules

Runs every rule targeting the given structure (plus element- and association-scoped rules for the structure's atoms), binds $Variable references to in-scope facts via qname lookup, writes one VerificationResult row per rule, and returns the results plus a status-keyed summary. Decoding mode, 6 patterns (EqualTo, RollUp, RollForward, SumEquals, Exists, CoExists).

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
`structure_id`required	string	Structure to evaluate rules for. Resolves all rules scoped to this structure plus rules attached to its elements and associations.
`fact_set_id`optional	string	Optional FactSet id to stamp on each VerificationResult row. Allows results to be scoped to a specific period run once write paths populate the FactSet table on every run.
`period_start`optional	string (date)	Lower bound on the fact period window (inclusive).
`period_end`optional	string (date)	Upper bound on the fact period window (inclusive).

Example request

curl

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

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

EvaluateRulesResponse

Command-specific result payload

EvaluateRulesResponse fields

Field Type Description

structure_idrequired string

resultsrequired

VerificationResultLite[]

Persisted outcome of one Rule evaluation. One row per ``public.verification_results`` entry the rule engine writes. The envelope surfaces them so the block viewer's "Verification Results" tab and MCP ``list-verification-failures`` tool can render + aggregate without a second round-trip.

VerificationResultLite fields

Field	Type	Description
`id`required	string
`rule_id`required	string
`structure_id`optional	string
`fact_set_id`optional	string
`status`required	string	'pass' \| 'fail' \| 'error' \| 'skipped'. Enum closure enforced by the ``public.verification_results`` CHECK constraint.
`message`optional	string
`period_start`optional	string (date)
`period_end`optional	string (date)
`evaluated_at`optional	string (date-time)

summaryoptional

object

Status counts keyed by outcome string: ``{'pass': N, 'fail': N, 'error': N, 'skipped': N}``.

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