# SGit Newsroom API (api.newsroom.sgit.ai) > A client-side API for a newsroom: the reading meter, the reader's personas, reading lists in a link, subscribe and the encrypted share, the reader's vault, search, the wire reader. Components, formats and contracts the browser runs, with no server and nothing to deploy but files, served at https://api.newsroom.sgit.ai//. Current release: v0.2.5. Source: https://github.com/SGit-AI/SGit-AI__Website__Newsroom__API. The live example: https://newsroom.sgit.ai/. Site version: v0.2.14 (reader-code release v0.2.5) ## Pages - [About, licence, contact](https://api.newsroom.sgit.ai/about/): What this site and repository are, who is responsible, the licence, how to reach the people behind it, and the disclosure about how it is written. - [Adopt it](https://api.newsroom.sgit.ai/adopt/): Three ways in: put the meter on your own pages today; run a newsroom like newsroom.sgit.ai; pilot it with the people who built it. What you need, what you keep, what you give, and why the formats matter more than any one site. - [For agents](https://api.newsroom.sgit.ai/agents/): The brief for the agents that keep this repository and the newsroom: what the API is, the rules, where everything is, how a change is made and reviewed, how the newsroom consumes a release, and what never to do. Written for people too. - [The components](https://api.newsroom.sgit.ai/docs/components/): The served files by group, what each is for, where it came from, and which are frozen: SG Meter and its versions, the component base, the reading lists, subscribe, the vault layer and the pane, search and ask, the wire reader, the vendored vault library, the passkey lab. - [The hosting model](https://api.newsroom.sgit.ai/docs/hosting/): How the reader code is served and consumed: a versioned prefix per release, never edited in place; the CORS header a cross-origin import needs; what stays on the page's origin (state, data, addresses); data-root; pinning, the manifest, rollback; CSP. - [Reference](https://api.newsroom.sgit.ai/docs/): The reference for the SGit Newsroom API: the contracts, the reader's state and every input and output, the components and what each file is, the hosting model, pinning and the manifest, the reading-list link grammar, events. - [The reading-list link](https://api.newsroom.sgit.ai/docs/reading-list-link/): The grammar of a reading list in a link, field by field, with the limits the parser enforces, how a list opens as a visitor persona, and what is deliberately not in it. - [For developers](https://api.newsroom.sgit.ai/for-developers/): Add the reading meter to a page with a pinned, versioned import and a JSON config; the custom element's views; the data your site publishes; the hosting model and CORS; the tests you can run against your own pages. - [For evaluators](https://api.newsroom.sgit.ai/for-evaluators/): The architecture, the trust boundaries, what leaves the browser, the review's findings as public issues, the release manifest, the proof of the move, the pipeline, and how to verify every claim yourself. - [For publishers, editors and executives](https://api.newsroom.sgit.ai/for-publishers/): What a reader gets, what the newsroom keeps, what it costs to adopt, what is live and taking money, and what is honestly not there yet. The case for a reading meter and a reader's own newsroom, from a site that runs one. - [Add the meter to a page](https://api.newsroom.sgit.ai/how-to/add-the-meter/): Put the reading meter on your site: the element at the foot of each page, the balance chip in the nav, the JSON config written once by your build, the pinned import, the account pages, and the article feed the picks read. - [How-to guides](https://api.newsroom.sgit.ai/how-to/): One task each: add the meter to a page; make a reading-list link; open the newsroom as a persona; set up the subscribe lane; take a release and roll one back; run the tests; make a release. - [Make a release](https://api.newsroom.sgit.ai/how-to/make-a-release/): For maintainers: the rules while the files are frozen, the version file, cutting a release directory and its manifest, the checks, the pull request with a person and an agent reviewer, the deploy, the tag and the live check, then the consumers. - [Open the newsroom as a persona](https://api.newsroom.sgit.ai/how-to/persona-link/): Persona links, persona pages and links.json: how a link opens the site as a founder, a journalist, a security lead, a builder or a board member, what a visitor persona is, and how a site defines its presets. - [Make a reading-list link](https://api.newsroom.sgit.ai/how-to/reading-list-link/): Send someone a set of articles as one link, by hand from the grammar or with the make page; what they see when they open it; how a site adds the two pages. - [Run the tests](https://api.newsroom.sgit.ai/how-to/run-the-tests/): The eleven test files, what each covers, how the harness serves a newsroom checkout and routes this host to the working tree, the three engines, which tests need Chromium, and how to run them against your own pages. - [Set up the subscribe lane](https://api.newsroom.sgit.ai/how-to/subscribe-lane/): How shares, subscriptions and notes reach a newsroom without a server: a key pair, a write-only lane in an encrypted vault on an SG/Send host, the contact file at /.well-known/, and reading the lane with the key alone. - [Take a release, roll one back](https://api.newsroom.sgit.ai/how-to/take-a-release/): For a site that consumes the API: pin one release in one file, generate every URL from it, keep a copy of the manifest, check every page against it, and roll back by changing the line. The newsroom's procedure as the worked example. - [A newsroom's reader, as an API](https://api.newsroom.sgit.ai/): The reading meter, pay-after-you-read, personas, reading lists in a link, the reader's vault: the code a newsroom's reader runs, open source, served from one host, live on newsroom.sgit.ai and taking money. - [Search](https://api.newsroom.sgit.ai/search/): Every page of this site, searched in your browser with the same component newsroom.sgit.ai uses, loaded from this host's own release; and asked, with Chrome's built-in model or your own OpenRouter key, answered from the passages found. - [The contracts](https://api.newsroom.sgit.ai/docs/contracts/): The fourteen contracts other sites, pages and agents program against: the meter config, a charged page, persona links, the reading-list link, article numbers, the return page, the export, the share, the envelope, the contact file, the wire's vault, events, a component, the import's rules. - [State, inputs and outputs](https://api.newsroom.sgit.ai/docs/state/): Where a reader's data lives (localStorage on the page's origin), everything that comes in, and every channel by which anything leaves the browser. - [The map, and the review](https://api.newsroom.sgit.ai/review/): Everything a reader runs on newsroom.sgit.ai, mapped before the move and reviewed line by line: the numbers, the eighteen findings as issues, the accepted gaps. - [The map as a graph](https://api.newsroom.sgit.ai/review/map/): The map of the reader code as a layered graph: the site, the pages, the views, the files, the contracts and the findings anchored to them. - [The proof of the move](https://api.newsroom.sgit.ai/review/proof/): The live site serves the same bytes before and after the move, by hash: every file, the frozen copies, and every page once normalised. - [Versions](https://api.newsroom.sgit.ai/versions/): Every version of this repository that landed on dev, newest first, with the reader-code release each one serves and what changed, in a line. - [Releases](https://api.newsroom.sgit.ai/releases/): Every release of the reader code served from api.newsroom.sgit.ai, its date, its notes, its manifest of paths and hashes, and the files that differ from the newsroom's bytes and why. - [The articles behind it](https://api.newsroom.sgit.ai/articles/): The newsroom.sgit.ai articles that designed, built and reviewed this API, curated for publishers, for the reader's own newsroom, and for the engineering. ## Data - [v0.2.5/manifest.json](https://api.newsroom.sgit.ai/v0.2.5/manifest.json): every served path with its bytes and SHA-256 - [releases.json](https://api.newsroom.sgit.ai/releases.json): every release - [feed.xml](https://api.newsroom.sgit.ai/feed.xml): versions and releases, as RSS - [search/docs.json](https://api.newsroom.sgit.ai/search/docs.json) and [search/text.json](https://api.newsroom.sgit.ai/search/text.json): the search index, one entry per page and the text in paragraphs - [review/map/graph.json](https://api.newsroom.sgit.ai/review/map/graph.json): the map as a graph - [the newsroom's articles/ids.json](https://newsroom.sgit.ai/articles/ids.json): the article-number contract - [the newsroom's articles/graphs.json](https://newsroom.sgit.ai/articles/graphs.json): the article feed