Federal Register

Overview

The Federal Register itself — who changed what, when, and what is still open for comment.

status
live
document id
doc_id e.g. fr:2024-07332
citation
[89 FR 12345]

Common calls

Rules from one agencyPOST /v1/fr/search {"query": "PFAS drinking water", "filters": {"doc_type": "Rule"}}
Proposed rules still open for commentPOST /v1/fr/search {"query": "出口管制 半导体", "filters": {"doc_type": "Proposed Rule", "comments_close_on": {"gte": "2026-10-09"}}}
Read oneGET /v1/fr/read/fr:2024-07332

Words, not meaning. This domain has no vectors: mode is keyword and a sentence describing what you want will find nothing — give it the terms. Quoted phrases, OR and -exclusions work; Chinese is segmented, and a mixed query is split into both.

The fine print
  • Division of labour with us_law: us_law holds the provisions in force (clause-level CFR / USC); fr holds the notices themselves (who changed what, when).
  • doc_type uses the official capitalisation (Rule / Proposed Rule / Notice / Presidential Document / Uncategorized Document / Correction / Sunshine Act Document); lowercase 'rule' matches nothing.
  • Rules open for comment: filters.comments_close_on={"gte": "<today>"}; upcoming effect: a range on effective_on.
  • subjects is an open model-generated label set and is not filterable before normalisation — filter on fr_topics (the official topics) instead.
  • No vectors: the query runs as an English tsvector and a Chinese zhparser pass whose results are unioned; mixed queries are split automatically, and quoted phrases / OR / -exclusion work.
  • Model-written fields (summarise, do not quote): action_kind, affected, key_point, one_liner, one_liner_zh, subjects.
  • The field table and enumerations are generated from the store's own self-description (search.field), not hand-written; enumeration counts are as of 2026-10-13.

Read

GET/v1/fr/read/{doc_id}
Three depths. detail is the default. Free sample: fr:2024-07332.

Levels

levelcreditsreturns
brief1Card: action_kind, agencies, citation, doc_id, doc_type, html_url, one_liner, one_liner_zh…
detail (default)2Every structured field (card plus the source abstract and detail fields)

Parameters

ParameterTypeDescription
doc_id (path) REQUIRED string Document id (doc_id).
level brief · detail= detail How deep to read.
format json · md · html= json Response shape.

Example

{ "domain": "fr", "id": "fr:2024-07332", "level": "detail", "view": "detail", "data": { … } | "text": "…", "token_count": 1834, "meta": { … } }
The older GET /v1/fr/doc/{id}?view=… still works.

Read many

POST/v1/fr/read
Up to 50 ids, one level. Missing ids come back with error: "not_found" and are not charged.

Parameters

ParameterTypeDescription
ids REQUIRED string[] Document ids.
level brief · detail= detail Level for every id.

Example

{ "domain": "fr", "level": "detail", "docs": [ { "id": "…", "data": { … } }, { "id": "…", "error": "not_found" } ], "meta": { … } }

Facets

GET/v1/fr/facets?field={field}
Legal values for a filter field, so an agent never guesses; precomputed fields carry counts, declared enums come without. Free, no key.

Parameters

ParameterTypeDescription
field REQUIRED action_kind · doc_type Filter field with facets.
limit integer= 50 Max values.

Example

{ "domain": "fr", "field": "…", "values": [ { "value": "…", "count": 3120 } ], "meta": { … } }

Askregistered key+ /stream

POST/v1/fr/ask
Agentic Q&A over this domain: with no vector layer, the model turns the question into structured filters plus bilingual full-text search, reads the hits and answers with [fr: ] citations; /stream is NDJSON with real token deltas. <code>effort</code> low / medium / high = 50 / 100 / 200 credits. Append <code>/stream</code> for NDJSON; the first event is always <code>billing</code>. A failure before the first <code>answer_delta</code> is refunded.</div> <h4>Parameters</h4> <div class="tblwrap"><table class="tbl t3 tparam"> <thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead> <tbody> <tr> <td>query<span class="req"> REQUIRED</span></td> <td class="ty">string</td> <td>1–2000 characters. Be specific; ask for numbers if you want numbers.</td> </tr><tr> <td>effort</td> <td class="ty">low · medium · high<span class="def">= low</span></td> <td>Reading rounds, and the price: 50 / 100 / 200 credits. Your plan caps it.</td> </tr><tr> <td>verbose</td> <td class="ty">bool<span class="def">= false</span></td> <td>Include the tool-call trace (tool_call / tool_result / thinking events when streaming).</td> </tr><tr> <td>top_k</td> <td class="ty">integer<span class="def">= 10</span></td> <td>Speculative prefetch size.</td> </tr><tr> <td>stream_answer</td> <td class="ty">bool<span class="def">= true</span></td> <td>Streaming only: false emits one answer event instead of deltas.</td> </tr><tr> <td>max_rounds</td> <td class="ty">integer</td> <td>0–8, overrides the effort preset.</td> </tr><tr> <td>force_answer_after</td> <td class="ty">number</td> <td>Seconds; hard cutover into the answer phase.</td> </tr><tr> <td>max_answer_tokens</td> <td class="ty">integer<span class="def">= 4096</span></td> <td>Hitting it sets answer_truncated.</td> </tr><tr> <td>language</td> <td class="ty">string</td> <td>Answer language; defaults to the query’s.</td> </tr> </tbody> </table></div> <h4>Example</h4> <pre class="code">{ "answer": "… [89 FR 12345] …", "sources": [ … ], "stats": { "rounds": 1, "elapsed_s": 6.2, "answer_truncated": false }, "coverage"?: { … }, "meta": { "credits": { "charged": 50, … } } }</pre> <div class="callout "><b>Citations are real</b> — every id in <code>answer</code> exists in this domain (format <code>[89 FR 12345]</code>). <b><code>sources</code> is the retrieval set</b>, not the citation list. <b><code>answer_truncated</code> means incomplete.</b></div> </section> </div> </div> <aside class="pg" data-playground> <div class="pg-handle" data-pg-handle></div> <div class="pg-head"><b>Playground</b><span class="hint">Follows the section you are reading</span><button class="icon-btn" data-pg-close type="button" aria-label="Close">✕</button></div> <div class="pg-body" data-pg-body></div> <script type="application/json" data-pg-specs>[{"id":"fr-search","domain":"fr","method":"POST","path":"/v1/fr/search","auth":"optional","status":"live","title":{"en":"Search","zh":"检索"},"summary":{"en":"Hybrid retrieval, one card per hit. 2 credits. Free sample: <code>PFAS drinking water</code>.<h4 class=\"sub\">Filter fields</h4><div class=\"tblwrap\"><table class=\"tbl t3\"><thead><tr><th>field</th><th>type · ops</th><th>meaning</th></tr></thead><tbody><tr><td class=\"mono\">action_kind</td><td class=\"mono dim\">keyword · eq any<span class=\"vals\">information_collection · meeting_or_hearing · amendment · approval_or_authorization · determination_or_finding · other <span class=\"dim\">… 19 values, /facets lists them all</span></span></td><td>Action kind (closed set of 19, model-assigned)</td></tr><tr><td class=\"mono\">agencies</td><td class=\"mono dim\">keyword · eq any</td><td>Issuing agencies (several allowed, any match)</td></tr><tr><td class=\"mono\">doc_type</td><td class=\"mono dim\">keyword · eq any<span class=\"vals\">Notice · Rule · Proposed Rule · Uncategorized Document · Presidential Document · Correction · Sunshine Act Document</span></td><td>Document type (official capitalisation: Rule / Proposed Rule / Notice / Presidential Document …)</td></tr><tr><td class=\"mono\">pub_date</td><td class=\"mono dim\">datetime · range</td><td>Publication date range</td></tr></tbody></table></div><details class=\"adv\"><summary>8 more, all usable</summary><div class=\"tblwrap\"><table class=\"tbl t3\"><thead><tr><th>field</th><th>type · ops</th><th>meaning</th></tr></thead><tbody><tr><td class=\"mono\">cfr_refs</td><td class=\"mono dim\">keyword · eq any</td><td>CFR references touched, e.g. 40 CFR 141</td></tr><tr><td class=\"mono\">comments_close_on</td><td class=\"mono dim\">datetime · range</td><td>Comment close date range</td></tr><tr><td class=\"mono\">docket_ids</td><td class=\"mono dim\">keyword · eq any</td><td>Docket ids</td></tr><tr><td class=\"mono\">document_number</td><td class=\"mono dim\">keyword · eq any</td><td>Document number (exact, e.g. 2024-07332)</td></tr><tr><td class=\"mono\">effective_on</td><td class=\"mono dim\">datetime · range</td><td>Effective date range</td></tr><tr><td class=\"mono\">fr_topics</td><td class=\"mono dim\">keyword · eq any</td><td>Official Federal Register topics</td></tr><tr><td class=\"mono\">rins</td><td class=\"mono dim\">keyword · eq any</td><td>RINs</td></tr><tr><td class=\"mono\">significant</td><td class=\"mono dim\">bool · eq</td><td>Whether it is a significant regulatory action</td></tr></tbody></table></div></details>","zh":"混合检索，每条命中一张卡片。2 credits。免费样例：<code>PFAS drinking water</code>。<h4 class=\"sub\">过滤字段</h4><div class=\"tblwrap\"><table class=\"tbl t3\"><thead><tr><th>字段</th><th>类型 · op</th><th>含义</th></tr></thead><tbody><tr><td class=\"mono\">action_kind</td><td class=\"mono dim\">keyword · eq any<span class=\"vals\">information_collection · meeting_or_hearing · amendment · approval_or_authorization · determination_or_finding · other <span class=\"dim\">…共 19 个，/facets 可列全</span></span></td><td>行为类型（闭集 19 类，模型判定）</td></tr><tr><td class=\"mono\">agencies</td><td class=\"mono dim\">keyword · eq any</td><td>发布机构（可多选，任一命中）</td></tr><tr><td class=\"mono\">doc_type</td><td class=\"mono dim\">keyword · eq any<span class=\"vals\">Notice · Rule · Proposed Rule · Uncategorized Document · Presidential Document · Correction · Sunshine Act Document</span></td><td>文种（注意是官方写法，首字母大写：Rule / Proposed Rule / Notice / Presidential Document …）</td></tr><tr><td class=\"mono\">pub_date</td><td class=\"mono dim\">datetime · range</td><td>发布日期区间</td></tr></tbody></table></div><details class=\"adv\"><summary>还有 8 个，照样能用</summary><div class=\"tblwrap\"><table class=\"tbl t3\"><thead><tr><th>字段</th><th>类型 · op</th><th>含义</th></tr></thead><tbody><tr><td class=\"mono\">cfr_refs</td><td class=\"mono dim\">keyword · eq any</td><td>涉及的 CFR 条文，如 40 CFR 141</td></tr><tr><td class=\"mono\">comments_close_on</td><td class=\"mono dim\">datetime · range</td><td>评论截止日期区间</td></tr><tr><td class=\"mono\">docket_ids</td><td class=\"mono dim\">keyword · eq any</td><td>案卷号（docket）</td></tr><tr><td class=\"mono\">document_number</td><td class=\"mono dim\">keyword · eq any</td><td>公报文号（精确，如 2024-07332）</td></tr><tr><td class=\"mono\">effective_on</td><td class=\"mono dim\">datetime · range</td><td>生效日期区间</td></tr><tr><td class=\"mono\">fr_topics</td><td class=\"mono dim\">keyword · eq any</td><td>联邦公报官方主题词</td></tr><tr><td class=\"mono\">rins</td><td class=\"mono dim\">keyword · eq any</td><td>RIN（统一议程编号）</td></tr><tr><td class=\"mono\">significant</td><td class=\"mono dim\">bool · eq</td><td>是否 significant regulatory action</td></tr></tbody></table></div></details>"},"params":[{"name":"query","type":"string","required":true,"in":"body","example":"PFAS drinking water","desc":{"en":"1–1000 characters. Or an array of up to 5 (batch; hits become results[]).","zh":"1–1000 字符。也可以是最多 5 条的数组（批量，hits 变 results[]）。"}},{"name":"top_k","type":"integer","default":"10","in":"body","desc":{"en":"1–200.","zh":"1–200。"}},{"name":"fields","type":"enum","options":["brief","head"],"default":"brief","in":"body","desc":{"en":"head costs one more credit and returns the head view per hit.","zh":"head 多扣 1 credit，每条附 head 视图。"}},{"name":"filters","type":"json","in":"body","example":"","desc":{"en":"Filter DSL object (see Getting started); declared fields are listed above.","zh":"过滤 DSL 对象（见快速开始）；可用字段见上表。"}},{"name":"mode","type":"enum","options":["keyword"],"default":"keyword","in":"body","advanced":true,"desc":{"en":"This domain has one mode — keyword matching, not semantics.","zh":"这个域只有一种模式——词面匹配，不是语义检索。"}},{"name":"sort","type":"enum","options":["relevance","date","pub_date"],"default":"relevance","in":"body","desc":{"en":"Order of the hits. ","zh":"结果排序。"}},{"name":"offset","type":"integer","default":"0","in":"body","advanced":true,"desc":{"en":"Pagination.","zh":"翻页。"}}],"example":"{ \"domain\": \"fr\", \"query\": \"…\", \"hits\": [ { \"id\": \"fr:2024-07332\", \"score\": 0.83, \"brief\": { … } } ], \"total\": null, \"coverage\": …, \"warnings\": [],\n \"meta\": { \"request_id\": \"req_…\", \"credits\": { \"charged\": 2, \"balance\": 1998, \"pool\": \"allowance\" }, \"latency_ms\": 41, \"cached\": false } }","notes":[{"html":{"en":"<b>Undeclared filter fields return 400</b> rather than being ignored silently. Filters combine with AND; <code>_or</code> / <code>_not</code> are available.","zh":"<b>用了未声明的过滤字段返回 400</b>，不会静默忽略。过滤条件是 AND；可用 <code>_or</code> / <code>_not</code>。"}}]},{"id":"fr-read","domain":"fr","method":"GET","path":"/v1/fr/read/{doc_id}","auth":"optional","status":"live","title":{"en":"Read","zh":"读"},"summary":{"en":"Three depths. <code>detail</code> is the default. Free sample: <code>fr:2024-07332</code>.<h4 class=\"sub\">Levels</h4><div class=\"tblwrap\"><table class=\"tbl t3 tnum\"><thead><tr><th>level</th><th>credits</th><th>returns</th></tr></thead><tbody><tr><td class=\"mono\">brief</td><td class=\"mono num\">1</td><td>Card: action_kind, agencies, citation, doc_id, doc_type, html_url, one_liner, one_liner_zh…</td></tr><tr><td class=\"mono\">detail <span class=\"dim\">(default)</span></td><td class=\"mono num\">2</td><td>Every structured field (card plus the source abstract and detail fields)</td></tr></tbody></table></div>","zh":"三档深浅，不传就是 <code>detail</code>。免费样例：<code>fr:2024-07332</code>。<h4 class=\"sub\">三档</h4><div class=\"tblwrap\"><table class=\"tbl t3 tnum\"><thead><tr><th>深浅</th><th>credits</th><th>返回</th></tr></thead><tbody><tr><td class=\"mono\">brief</td><td class=\"mono num\">1</td><td>卡片：action_kind、agencies、citation、doc_id、doc_type、html_url、one_liner、one_liner_zh…</td></tr><tr><td class=\"mono\">detail <span class=\"dim\">（默认）</span></td><td class=\"mono num\">2</td><td>全部结构化字段（卡片 + 原文摘要 / 明细字段）</td></tr></tbody></table></div>"},"params":[{"name":"doc_id","type":"string","required":true,"in":"path","example":"fr:2024-07332","desc":{"en":"Document id (doc_id).","zh":"文档 id（doc_id）。"}},{"name":"level","type":"enum","options":["brief","detail"],"default":"detail","desc":{"en":"How deep to read.","zh":"读多深。"}},{"name":"format","type":"enum","options":["json","md","html"],"default":"json","desc":{"en":"Response shape.","zh":"响应形态。"}}],"example":"{ \"domain\": \"fr\", \"id\": \"fr:2024-07332\", \"level\": \"detail\", \"view\": \"detail\", \"data\": { … } | \"text\": \"…\", \"token_count\": 1834, \"meta\": { … } }","notes":[{"html":{"en":"The older <code>GET /v1/fr/doc/{id}?view=…</code> still works.","zh":"旧写法 <code>GET /v1/fr/doc/{id}?view=…</code> 仍然可用。"}}]},{"id":"fr-read-batch","domain":"fr","method":"POST","path":"/v1/fr/read","auth":"token","status":"live","title":{"en":"Read many","zh":"批量读"},"summary":{"en":"Up to 50 ids, one level. Missing ids come back with <code>error: \"not_found\"</code> and are not charged.","zh":"最多 50 个 id，同一档。查不到的 id 返回 <code>error: \"not_found\"</code>，不扣费。"},"params":[{"name":"ids","type":"array","list":true,"required":true,"in":"body","example":"fr:2024-07332","desc":{"en":"Document ids.","zh":"文档 id 列表。"}},{"name":"level","type":"enum","options":["brief","detail"],"default":"detail","in":"body","desc":{"en":"Level for every id.","zh":"所有 id 共用的档。"}}],"example":"{ \"domain\": \"fr\", \"level\": \"detail\", \"docs\": [ { \"id\": \"…\", \"data\": { … } }, { \"id\": \"…\", \"error\": \"not_found\" } ], \"meta\": { … } }"},{"id":"fr-facets","domain":"fr","method":"GET","path":"/v1/fr/facets","auth":"none","status":"live","title":{"en":"Facets","zh":"Facets"},"summary":{"en":"Legal values for a filter field, so an agent never guesses; precomputed fields carry counts, declared enums come without. Free, no key.","zh":"某个过滤字段的合法值，agent 不用猜；预聚合字段带计数，声明的枚举没有。免费、不需要 key。"},"params":[{"name":"field","type":"enum","options":["action_kind","doc_type"],"required":true,"example":"action_kind","desc":{"en":"Filter field with facets.","zh":"有 facets 的过滤字段。"}},{"name":"limit","type":"integer","default":"50","advanced":true,"desc":{"en":"Max values.","zh":"最多返回多少个值。"}}],"example":"{ \"domain\": \"fr\", \"field\": \"…\", \"values\": [ { \"value\": \"…\", \"count\": 3120 } ], \"meta\": { … } }"},{"id":"fr-ask","domain":"fr","method":"POST","path":"/v1/fr/ask","auth":"registered","status":"live","stream":true,"agentic":true,"title":{"en":"Ask","zh":"问"},"summary":{"en":"Agentic Q&A over this domain: with no vector layer, the model turns the question into structured filters plus bilingual full-text search, reads the hits and answers with [fr:<doc_id> <title>] citations; /stream is NDJSON with real token deltas. <code>effort</code> low / medium / high = 50 / 100 / 200 credits. Append <code>/stream</code> for NDJSON; the first event is always <code>billing</code>. A failure before the first <code>answer_delta</code> is refunded.","zh":"本域的 agentic 问答：没有向量层，模型把问题翻成结构化筛选 + 中英分词全文检索，读详情后作答，引用写成 [fr:<doc_id> <标题>]；/stream 为 NDJSON，answer_delta 是边生成边发的真实片段。<code>effort</code> low / medium / high 对应 50 / 100 / 200 credits。加 <code>/stream</code> 走 NDJSON，第一个事件一定是 <code>billing</code>。首个 <code>answer_delta</code> 之前失败会退款。"},"params":[{"name":"query","type":"string","required":true,"in":"body","example":"PFAS drinking water","desc":{"en":"1–2000 characters. Be specific; ask for numbers if you want numbers.","zh":"1–2000 字符。问得具体；要数字就直接问数字。"}},{"name":"effort","type":"enum","options":["low","medium","high"],"default":"low","in":"body","desc":{"en":"Reading rounds, and the price: 50 / 100 / 200 credits. Your plan caps it.","zh":"检索轮数，也决定价格：50 / 100 / 200 credits。套餐限制最高档。"}},{"name":"verbose","type":"bool","default":"false","in":"body","desc":{"en":"Include the tool-call trace (tool_call / tool_result / thinking events when streaming).","zh":"返回工具调用轨迹（流式时多 tool_call / tool_result / thinking 事件）。"}},{"name":"top_k","type":"integer","default":"10","in":"body","advanced":true,"desc":{"en":"Speculative prefetch size.","zh":"预取候选数。"}},{"name":"stream_answer","type":"bool","default":"true","in":"body","advanced":true,"desc":{"en":"Streaming only: false emits one answer event instead of deltas.","zh":"仅流式：false 时只发一个 answer 事件。"}},{"name":"max_rounds","type":"integer","in":"body","advanced":true,"desc":{"en":"0–8, overrides the effort preset.","zh":"0–8，覆盖 effort 预设。"}},{"name":"force_answer_after","type":"number","in":"body","advanced":true,"desc":{"en":"Seconds; hard cutover into the answer phase.","zh":"秒；强制切入作答阶段。"}},{"name":"max_answer_tokens","type":"integer","default":"4096","in":"body","advanced":true,"desc":{"en":"Hitting it sets answer_truncated.","zh":"触顶时置 answer_truncated。"}},{"name":"language","type":"string","in":"body","advanced":true,"desc":{"en":"Answer language; defaults to the query’s.","zh":"回答语言，默认跟随 query。"}}],"example":"{ \"answer\": \"… [89 FR 12345] …\", \"sources\": [ … ], \"stats\": { \"rounds\": 1, \"elapsed_s\": 6.2, \"answer_truncated\": false }, \"coverage\"?: { … }, \"meta\": { \"credits\": { \"charged\": 50, … } } }","notes":[{"html":{"en":"<b>Citations are real</b> — every id in <code>answer</code> exists in this domain (format <code>[89 FR 12345]</code>). <b><code>sources</code> is the retrieval set</b>, not the citation list. <b><code>answer_truncated</code> means incomplete.</b>","zh":"<b>引用是真的</b>——<code>answer</code> 里的每个 id 都存在于本垂域（格式 <code>[89 FR 12345]</code>）。<b><code>sources</code> 是召回集</b>，不是引用列表。<b><code>answer_truncated</code> 表示不完整。</b>"}}]}]</script> <script type="application/json" data-pg-strings>{"title":"Playground","hint":"Follows the section you are reading","token":"API token","tokenHint":"fa_live_… key · optional for free samples · stored in this browser only","tokenReq":"API key required (fa_live_…)","send":"Send request","stream":"Stream","response":"Response","events":"Events","answer":"Answer","sources":"Sources","cited":"cited","retrieved":"retrieved","stats":"Stats","coming":"This domain is still building. The request shape is final; sending is disabled until it is live.","open":"Playground","close":"Close","tokens":"tokens","chars":"characters","truncated":"answer truncated","code":"Code","openTab":"Open in a new tab","report":"This one is wrong — report it","quotaHit":"Daily quota used up ({used} / {limit}, resets {reset}). It is a quota, not a rate limit, so retrying will not help: write to {mail} about {grant}.","rateHit":"Over your rpm. Retry in {n} s.","lang":"en","apiBase":"https://api.1stauthor.com","codeBase":"https://api.1stauthor.com","keys":"/dashboard/keys/","fb":"/feedback/","contact":"tommy@chien.io"}</script> </aside> <button class="btn btn-primary pg-fab" data-pg-open type="button">Playground</button> <script type="module" src="/_astro/DocsShell.astro_astro_type_script_index_0_lang.cOZozF12.js"></script> </main> <script type="module" src="/_astro/Base.astro_astro_type_script_index_0_lang.B9qjIrvh.js"></script> </body> </html>