Query parameters
Knowledge time. Only rows learned at or before this instant are returned. A date is widened to its end of day (UTC).
Content time. Only rows whose
valid interval contains valid_at. A row with no valid_from also needs asserted_at <= valid_at; a row that declares one holds from it, even when it was said later (a retroactive rule).One topic label, exact match. See grouping data.
Only the blocks that state a value for this fact (their
fact_key). The fact does not have to be declared. Combines with the other filters; without it the read is unchanged.Only the blocks whose
fact_key starts with this string, compared character by character (_ and % are not wildcards). With keys shaped <subject>/<attr>, fact_key_prefix=s_123/ reads everything known about one subject at as_of, in force at valid_at, in one request. Combines with the other filters, fact_key included. A block bound to no fact never matches (0.3.24).The case you are asking about, as
{key: value}, for example {"filing_status": "single", "tax_year": "2025-06-30"}. A block whose applies_if does not hold for it is left out: every condition must hold, and a condition on a key you did not give fails. eq compares strings (a list means one of them); after and before read the fact as a date or instant and compare strictly. Without facts every block is returned, conditional or not. Anything but a JSON object is 400 TCKG_BAD_FACTS.Only these ids:
?id=a&id=b. Checks which of many ids are visible at as_of in one request; an id that is not is left out, not an error. To ask whether ids are in the ledger at all, whatever their validity, use lookup. Also the way to read an id a path cannot carry (/, ?). Combines with the other filters. The cost follows the number of ids asked for, not the size of the space.The
next of the previous page. Rows come in id order and at one instant a tenant has one row per id, so the pages of one as_of joined equal the unpaged read. Keep as_of fixed across pages.Response
See shared shapes. Each row also carries
superseded_by and superseded_since, decided exactly as on search hits at the same as_of, valid_at and facts: the id of the block that superseded it through a SUPERSEDES edge known by as_of and in force at valid_at, and when that took effect. Both null when nothing supersedes it then (0.3.24).Rows hidden because of
as_of, by kind: {"node": n, "edge": n, "verdict": n}. Null when nothing was hidden.See Concepts. It certifies the whole read (its space, or the tenant, at
as_of), not the page or the id list. With facts it carries not_applicable, the number of blocks known at as_of in the read’s scope that were left out because their conditions do not hold (0 when none were); without facts the key is absent.