> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nitsor.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Nitsor is a pre-release product. Every page in this documentation carries an availability status in its frontmatter (`availability`) and, as the first element of its body, a link labelled `Available now`, `Limited design-partner access`, or `Planned - not available yet`. That label is binding: it says whether a reader can use the behaviour the page describes.
> A page written in the present tense is not a claim that the behaviour ships. Where the availability label says `Planned - not available yet`, the page describes a target contract and there is no runnable product, screen, command, or public interface behind it.
> Every readiness claim this documentation makes lives on the Product status page. If any statement elsewhere disagrees with the capability status matrix on that page, the matrix is correct.
> Reading this documentation grants no product access and no permission. No agent can create or approve a Nitsor release.

# Integrations and public interfaces

> See which public interfaces exist today and which APIs, tools, and product integrations are still planned.

<a className="nit-availability" data-availability="available-now" href="/product-status#status-definitions" aria-label="Available now. Read the status definitions."><span aria-hidden="true" className="nit-availability__dot" />Available now</a>

Nitsor publishes a small set of public interfaces, and none of them is a product API. This page lists what exists today, states the boundary on each one, and shows how the documentation itself reaches an AI tool.

## Available public interfaces

The current public site provides:

* server-rendered marketing and customer-documentation pages;
* a public contact form;
* ordinary HTML links and a sitemap;
* per-page Markdown documentation exports;
* an `llms.txt` index and an `llms-full.txt` export;
* curated, read-only context bundles for agents;
* a documentation search endpoint used by the public docs interface.

These interfaces help people read about Nitsor and contact the team. They are not APIs for product data.

## Contact form

The form accepts a name, email, optional company, and message. Automated tests cover validation and safe email formatting. They do not prove live email delivery, a response time, spam resistance, or a customer-support service.

Do not submit secrets, credentials, sensitive scans, patient or customer data, storage URLs, or confidential strategy.

## Contact form validation

Validation applies after leading and trailing whitespace is removed.

| Field   | Required | Exact validation                                       |
| ------- | -------- | ------------------------------------------------------ |
| Name    | Yes      | Trimmed; 1 to 120 characters.                          |
| Email   | Yes      | Trimmed; valid email address; 254 characters or fewer. |
| Company | No       | Trimmed; 120 characters or fewer.                      |
| Message | Yes      | Trimmed; 10 to 4,000 characters.                       |

## Agent-readable documentation

Each documentation page is also served as clean Markdown at the same address with `.md` added. An `llms.txt` index lists every page with its description, and `llms-full.txt` combines the complete set. Both are published by the documentation host at the documentation root.

**Pending — agent discovery documents.** The documentation host publishes machine-readable cards at `/.well-known/agent-card.json` and `/.well-known/mcp.json`, and answers a documentation MCP server at `/mcp`. All three were reached on the deployed origin on 24 August 2026. They stay Pending because both cards name a Mintlify-internal hostname as their own address rather than the documentation origin you are reading, so an agent that follows the address in the card leaves the public origin. Read the cards, but prefer the origin you fetched them from.

Agents should cite the HTML source URL included in each export and preserve availability labels. Agent-readable documentation grants no permission. No agent can create or approve a Nitsor release today.

Each written page starts as a Markdown file stored with the website code. Markdown uses plain-text formatting markers. This project uses MDX, a form of Markdown that can also include reviewed components.

Mintlify is the publishing system that turns those files into the pages you are reading. Each figure on this site states its own evidence status and carries the same facts as text.

<section aria-labelledby="docs-rich-publishing-pipeline" aria-describedby="docs-rich-publishing-pipeline-caption" className="nit-fig" role="figure">
  <div className="nit-fig__header">
    <p className="nit-fig__status">Publishing pipeline</p>
    <h2 className="nit-fig__title" id="docs-rich-publishing-pipeline">How one written source becomes six public outputs</h2>
  </div>

  <div className="nit-fig__body">
    <svg aria-labelledby="publishing-pipeline-title publishing-pipeline-description" className="nit-fig__graphic nit-fig__graphic--md" role="img" viewBox="0 0 360 510"><title id="publishing-pipeline-title">Nitsor documentation publishing pipeline</title><desc id="publishing-pipeline-description">Reviewed Markdown files supply each written page and machine-readable export. The documentation host renders them. Together they publish 22 HTML pages, per-page Markdown, search, llms.txt, llms-full.txt, and and a set of agent discovery documents that is published but still names a non-canonical address.</desc><rect className="nit-fig__box" height="72" rx="6" strokeWidth="2" width="280" x="40" y="12" /><text className="nit-fig__label" textAnchor="middle" x="180" y="42">Reviewed Markdown files</text><text className="nit-fig__detail" textAnchor="middle" x="180" y="64">written source and exports</text><g aria-hidden="true" className="nit-fig__arrow"><line strokeWidth="2" x1="180" x2="180" y1="84" y2="112" /><path d="M 174 104 L 180 112 L 186 104" strokeWidth="2" /></g><rect className="nit-fig__box nit-fig__box--accent" height="72" rx="6" strokeWidth="2" width="280" x="40" y="112" /><text className="nit-fig__label" textAnchor="middle" x="180" y="142">Documentation host</text><text className="nit-fig__detail" textAnchor="middle" x="180" y="164">pages, exports, and discovery</text><g aria-hidden="true" className="nit-fig__arrow"><line strokeWidth="2" x1="180" x2="180" y1="184" y2="212" /><path d="M 174 204 L 180 212 L 186 204" strokeWidth="2" /></g><text className="nit-fig__label nit-fig__label--sm" textAnchor="middle" x="180" y="232">Public outputs</text><g><rect className="nit-fig__chip" height="58" rx="5" strokeWidth="1.5" width="156" x="16" y="252" /><text className="nit-fig__label nit-fig__label--xs" textAnchor="middle" x="94" y="286">22 HTML pages</text></g><g><rect className="nit-fig__chip" height="58" rx="5" strokeWidth="1.5" width="156" x="188" y="252" /><text className="nit-fig__label nit-fig__label--xs" textAnchor="middle" x="266" y="286">Per-page Markdown</text></g><g><rect className="nit-fig__chip" height="58" rx="5" strokeWidth="1.5" width="156" x="16" y="328" /><text className="nit-fig__label nit-fig__label--xs" textAnchor="middle" x="94" y="362">Search</text></g><g><rect className="nit-fig__chip" height="58" rx="5" strokeWidth="1.5" width="156" x="188" y="328" /><text className="nit-fig__label nit-fig__label--xs" textAnchor="middle" x="266" y="362">llms.txt</text></g><g><rect className="nit-fig__chip" height="58" rx="5" strokeWidth="1.5" width="156" x="16" y="404" /><text className="nit-fig__label nit-fig__label--xs" textAnchor="middle" x="94" y="438">llms-full.txt</text></g><g><rect className="nit-fig__chip" height="58" rx="5" strokeWidth="1.5" width="156" x="188" y="404" /><text className="nit-fig__label nit-fig__label--xs" textAnchor="middle" x="266" y="438">/.well-known/ (pending)</text></g></svg>

    | Output                    | What it is                                                                               | Checked on a deployed origin |
    | ------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------- |
    | 22 HTML pages             | Every page in this documentation set.                                                    | Yes                          |
    | Per-page Markdown         | The same page at the same address with `.md` added.                                      | Yes                          |
    | Search                    | The documentation search control.                                                        | Yes                          |
    | `llms.txt`                | An index of every page for AI tools.                                                     | Yes                          |
    | `llms-full.txt`           | The complete text of every page in one file.                                             | Yes                          |
    | Agent discovery documents | Machine-readable cards under `/.well-known/`, plus a documentation MCP server at `/mcp`. | Pending                      |
  </div>

  <p className="nit-fig__caption" id="docs-rich-publishing-pipeline-caption">The last row is Pending: the agent discovery documents are published and reachable, but each card names a Mintlify-internal hostname as its own address rather than this documentation origin. Agent-readable outputs expose no actions and grant no permission.</p>
</section>

The export route is part of this site and does not require a Nitsor account.

The public origin is `https://docs.nitsor.com`, verified on 24 August 2026. For command-line use, set `NITSOR_DOCS_ORIGIN` to the origin of the reviewed site you are reading, without a trailing slash.

<Tabs>
  <Tab title="curl">
    ```bash theme={"system"}
    curl --fail --show-error --silent --max-time 10 "$NITSOR_DOCS_ORIGIN/index.md"
    ```
  </Tab>

  <Tab title="Python">
    ```python theme={"system"}
    import os
    import urllib.request

    origin = os.environ["NITSOR_DOCS_ORIGIN"].rstrip("/")

    with urllib.request.urlopen(f"{origin}/index.md", timeout=10) as page:
        print(page.read().decode())
    ```
  </Tab>

  <Tab title="JavaScript">
    ```js theme={"system"}
    const origin = process.env.NITSOR_DOCS_ORIGIN;

    if (!origin) {
      throw new Error("Set NITSOR_DOCS_ORIGIN to the reviewed documentation origin.");
    }

    const page = await fetch(new URL("/index.md", origin), {
      signal: AbortSignal.timeout(10_000),
    });

    if (!page.ok) {
      throw new Error(`Documentation request failed with HTTP ${page.status}.`);
    }

    console.log(await page.text());
    ```
  </Tab>
</Tabs>

Each example stops after ten seconds and treats an HTTP error as a failed request instead of printing the error page as documentation.

Reading these files grants no product access or permission.

## Context bundles

A context bundle is a prepared set of related pages. It makes focused reading easier and grants no permission or product access. Start with the `llms.txt` index, then choose the smallest bundle that covers your question.

| Bundle                                                                                    | What it covers                                                                          | Pages included                                                                                                        |
| ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| [Evaluate Nitsor](https://nitsor.com/docs/context/evaluate-nitsor.md)                     | Current status, data boundaries, integrations, deployment, and a first action.          | Introduction; Quickstart; Product status; Data boundary; Integrations and public interfaces; Deployment and security  |
| [Design-partner onboarding](https://nitsor.com/docs/context/design-partner-onboarding.md) | Fit, prerequisites, onboarding questions, and the security evidence a partner asks for. | Quickstart; Product status; Design-partner onboarding; Deployment and security                                        |
| [Dataset release](https://nitsor.com/docs/context/dataset-release.md)                     | The planned model for versioning, roles, review, and dataset releases.                  | Product status; Version model; Roles and provenance; Review, consensus, and adjudication; Release a dataset; Glossary |
| [Programmatic access](https://nitsor.com/docs/context/programmatic-access.md)             | Product status, public API, command-line interface, and data-model contracts.           | Product status; Integrations and public interfaces; Public HTTP API; Command-line interface; Data model and contracts |

Each bundle carries an estimated size. Those estimates are derived from the length of the text, not from any provider's billing, so treat them as a rough guide when choosing what to load.

## What the Markdown and HTML versions must agree on

| Fact                | Must agree | May differ                         |
| ------------------- | ---------- | ---------------------------------- |
| Main topic          | Yes        | No                                 |
| Availability status | Yes        | No                                 |
| Prerequisites       | Yes        | No                                 |
| Limits              | Yes        | No                                 |
| Next steps          | Yes        | No                                 |
| Navigation controls | No         | Yes — they may appear only in HTML |

If the two versions make contradictory claims, do not rely on either claim; use [Product status](/product-status) and contact the team with the page URL and exact wording.

## Programmatic and self-host surfaces

Implemented contracts do not all have the same availability. The API, CLI, and backend data contracts require an agreed design-partner environment. The self-host page is a target contract that distinguishes tested bootstrap mechanics from a supported product. None of these pages provides a public installation or sign-in path.

| Surface                              | Availability                  | Current boundary                                                                                                | Reference                                         |
| ------------------------------------ | ----------------------------- | --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- |
| Public HTTP API                      | Limited design-partner access | 16 implemented routes with hashed, scoped agent-credential authentication; no supported public environment yet. | [Public HTTP API](/reference/api)                 |
| Command-line interface               | Limited design-partner access | Five tested command families; no published release pipeline or public installation command.                     | [Command-line interface](/reference/cli)          |
| Data model and contracts             | Limited design-partner access | Replay-tested backend contracts; no supported operator product, and some target contracts remain planned.       | [Data model and contracts](/reference/data-model) |
| Self-host mechanics                  | Planned — not available yet   | Tested `nitsor up` bootstrap mechanics start dependencies, not a complete supported Nitsor product.             | [Self-host mechanics](/reference/self-host)       |
| SDK, MCP, webhook, and agent actions | Not available                 | No public package, server, webhook, or action surface is published.                                             | —                                                 |

Before depending on a future interface, work through the canonical [pre-integration acceptance gate](/guides/plan-an-integration#evidence-required-before-integration). Every item there — from a versioned release through export and migration behavior — applies to any interface listed as planned on this page.

## Search and machine consumption limits

Search ranking is intended for this small documentation set, not as a general knowledge base. Token counts are estimates based on text size, not provider-specific billing measurements. Agent answers remain synthetic and must not be treated as product or customer validation.

## Common mistakes and limits

* A `.md` documentation URL is not a product endpoint.
* A context bundle is not a tool permission.
* A description of a workflow is not an SDK example.
* Search visibility does not change product availability.
* Generated exports must not be copied into a private operational system without checking their public status and date.

## Next step

If you need a product interface, write the smallest executable acceptance test it would have to pass, then bring it to [Design-partner onboarding](/guides/design-partner-onboarding).

<table className="nit-page-details" aria-label="Page details">
  <tbody>
    <tr><th scope="row">Outcome</th><td>Choose only an interface that is genuinely available and record acceptance tests for future dependencies.</td></tr>
    <tr><th scope="row">Availability</th><td>Available now</td></tr>
    <tr><th scope="row">Audience</th><td>ML engineers, Data engineers, Software engineers, AI agents</td></tr>
    <tr><th scope="row">Prerequisites</th><td>Read Product status</td></tr>
    <tr><th scope="row">Last verified</th><td>2026-08-23</td></tr>
  </tbody>
</table>