How it runs
Every caller goes through one governed API. It resolves the tenant and identity, applies the caller's scopes, and shows a preview before any change. Behind it, four services share one index database and a private object store. Work nobody is waiting for runs in the background, in batch.
- Your software · HTTP API
- AI assistants · MCP
- Scripts · command line
CKS searches stored documents and claims in PostgreSQL and keeps the Open Knowledge Format record.
- Claims on web pages are rechecked before they go out of date.
- A topic can run a weekly market search and produce a monthly summary citing its claims.
- Background work pauses after an account is unused for a set time, then catches up once when someone returns.
The command line
Install on Windows:
powershell -ExecutionPolicy ByPass -c "irm https://cks.corvair.ai/download/cli/install.ps1 | iex"Install on macOS or Linux:
curl -LsSf https://cks.corvair.ai/download/cli/install.sh | shRun cks auth login, or cks auth login --device on a machine without a browser. The current version and SHA-256 are published with each release. On Windows the installer adds a cks command to your user PATH and adds no new program file, so it runs where Smart App Control is on. Open a new terminal after installing. If you installed cks on Windows before 11 November 2026, run the install command once more.
The cks program drives the Knowledge Substrate through its HTTP API. Sign in once in the browser, with the same sign-in and limits as Corvair Virtual Worker. Scripts use a key with a name, scopes and an end date. Every change shows a preview first.
cks auth login cks context set --tenant northcott --base "Company library" cks search "maximum working pressure NX-40" --facet tier cks ask "What does the warranty exclude?" -o json cks base archive "Old pilot" # shows the preview, then asks
API and MCP
Setting up? Connect an AI assistant or your own software. Building? The API reference lists every route, with sign-in, previews, errors and examples.
All routes are versioned. Read, change, preview and destructive operations are labelled, so clients and tools can treat them differently. Each MCP tool forwards to its API route, so access rules apply once for every interface.
| Area | Example routes | What for |
|---|---|---|
| Knowledge | /query/{kb_id}/search | Search, answers and browsing |
| Sources | /collect/{kb_id}/source-rules/{rule_id} | Sources, crawled sites and topic maps |
| Memory | /v1/conversations/{id} | Conversations, events and context |
| Vault | /vault/{id}/uploads, generated-files | Files, versions and generated files |
| Warrants | /warrants/{id}/verify | Sealing and checking |
| Admin | /admin/principals | People, access and settings |
The API, MCP tools and the command line
Open Knowledge Format
The Open Knowledge Format (OKF) is an open, vendor-neutral standard from Google Cloud for keeping knowledge as plain Markdown files, each with a short block of YAML front matter that describes it. The specification is published under the Apache 2.0 licence at github.com/GoogleCloudPlatform/open-knowledge-format.
Corvair Knowledge Substrate uses OKF as its own core format, not only for export. Every document it reads is kept as one OKF bundle, and that bundle is the record of truth. The index database is built from the bundles and can be rebuilt from them at any time, with no model call. Any tool that reads OKF can open a bundle, and a base can be exported as standard OKF and taken elsewhere intact.
What the standard provides
The Knowledge Substrate writes OKF 0.2, the current version. These standard fields carry most of what a reader needs.
| Field | What it records |
|---|---|
type, title, description | What the entry is, and a short summary of it. |
generated | How and when the content was produced: the reading pipeline and its version, or the service that generated it. |
sources | Where the content came from: the file or page, its author and when it last changed. A footnote ties each passage and claim to its source. |
verified | Each check made, by a machine or by a person. From these, OKF's trust level follows: unverified, machine-confirmed or human-reviewed. |
status, stale_after | Draft, stable or deprecated, and the date after which the content is stale. |
log.md | A dated history of changes to the bundle, newest first. |
type: document title: Halden supply agreement, version 3 description: Supply terms between Northcott and Halden, including notice and price review. generated: { by: cks-ingest/2.4, at: 2026-11-08T10:14:00+08:00 } sources: - { id: s1, resource: halden-supply-v3.pdf, author: Halden Ltd, last_modified: 2026-10-30T09:00:00+08:00 } verified: - { by: cks-claim-check, at: 2026-11-08T22:05:00+08:00 } status: stable stale_after: 2027-11-08T00:00:00+08:00 x-cks: # the Knowledge Substrate's extension block, below
What the Knowledge Substrate adds
OKF readers must accept keys they do not know. Everything the standard does not cover is kept in one extension block, x-cks, so any OKF reader can still open the bundle and simply skip what it does not use.
| Extension | What it holds | Why it is needed |
|---|---|---|
| Source tier | Tier 1 to Tier 4: licensed expertise, your own content, outside sites, or generated. | OKF's trust level says who checked the content. The source tier says where it came from. Both are kept. |
| Claims and their checks | Each claim's exact text, the passage it came from, and the result of its check. | So the index can be rebuilt without reading the document again. |
| Topics and terms | The base's topics, keywords and named things, with their other names. | Search by other names and spellings. |
| Typed relationships | Supersedes, cites, supports and contradicts, between documents and claims. | OKF links carry no type. |
| Classification | Sensitivity, personal data found, and language. | Not yet in the standard. |
| Fingerprint and entitlement | A fingerprint of the source's bytes, how it was collected, and who may use it under which licence. | Integrity, and licensed content. |
| Validity | How fast this kind of content goes stale. | The standard keeps only the resulting stale_after date. |
How it is kept current
- Pinned to the standard. The Knowledge Substrate pins an exact version of the specification from Google Cloud's repository, and checks that repository at each release.
- The extension is versioned on its own. A change to
x-cksnever breaks a reader of the standard fields. - Moving to the standard as it grows. When OKF adds a field for something the extension already holds, bundles move to the standard field, and readers accept the old one for one release. OKF 0.2's
sources,generatedanddeprecatedstatus replaced three of the Knowledge Substrate's own fields this way. - Proposed upstream. Extensions that would help others, such as fingerprints, sensitivity, licences and typed links, will be proposed to the standard.
- Export is plain OKF. An exported base is standard OKF bundles with the extension block alongside, so it can be read without Corvair.
Security and regions
Your knowledge plane holds your content, the store, answers and warrants, in the region you choose. The discovery plane reaches the open web. Only instructions cross out; findings come back and are checked before they count.
Glossary
Passage, claim, topic map, heat map, source tier, recipe, learning, binding, warrant and ledger, each in one or two plain sentences.
Downloads
Install on Windows:
powershell -ExecutionPolicy ByPass -c "irm https://cks.corvair.ai/download/cli/install.ps1 | iex"Install on macOS or Linux:
curl -LsSf https://cks.corvair.ai/download/cli/install.sh | shRun cks auth login, or cks auth login --device on a machine without a browser. The current version and SHA-256 are published with each release. On Windows the installer adds a cks command to your user PATH and adds no new program file, so it runs where Smart App Control is on. Open a new terminal after installing. If you installed cks on Windows before 11 November 2026, run the install command once more.
The API reference and the MCP tool list are published with each Knowledge Substrate release. Contact us for a copy of the current release.