Reference

SDK Documentation

OpenAPI, schemas, protocols, CLI, SDKs, generated examples, and error codes.

PublicSource-ownedMarkdown export

HELM Decision PathEvery governed call produces receipts that can be inspected, exported, and verified.

Audience

Outcome

After this page you should know what this surface is for, which source files own the behavior, which public route or adjacent page to use next, and which validation command to run before changing the claim.

Source Truth

Public route: reference/sdks
Source document: helm-ai-enterprise/docs/public/reference/sdks/index.md
Public manifest: helm-ai-enterprise/docs/public-docs.manifest.json
Source inventory: helm-ai-enterprise/docs/source-inventory.manifest.json
Validation: corepack pnpm run docs:coverage, corepack pnpm run docs:truth, and npm run coverage:inventory from docs-platform

Do not expand this page with unsupported product, SDK, deployment, compliance, or integration claims unless the inventory manifest points to code, schemas, tests, examples, or an owner doc that proves the claim.

Troubleshooting

Symptom	First check
A link or route is missing from the docs website	Check `docs/public-docs.manifest.json`, `llms.txt`, search, and the per-page Markdown export before changing navigation.
A claim is not backed by code or tests	Remove the claim or add the missing code, example, schema, or validation command before publishing.

Architecture

api/openapi/helm.openapi.yaml    ← Single source of truth
         │
    scripts/sdk/gen.sh           ← Generates types_gen.* files
         │
    ┌────┴────┬────────┬─────────┬──────────┐
    ▼         ▼        ▼         ▼          ▼
sdk/ts/    sdk/python/ sdk/go/  sdk/rust/  sdk/java/
 types.gen.ts  types_gen.py  types_gen.go  types_gen.rs  TypesGen.java
 client.ts     client.py     client.go     lib.rs        HelmClient.java
    │         │        │         │          │
    ▼         ▼        ▼         ▼          ▼
examples/  examples/  examples/ examples/  examples/

Contract → Code → Wrapper → Example

Layer	Purpose	Location
OpenAPI spec	Single truth source	`api/openapi/helm.openapi.yaml`
Generated types	Typed models	`sdk//types_gen.` (AUTO-GENERATED)
Ergonomic wrapper	HTTP client with error handling	`sdk//client.` (hand-written)
Examples	Runnable demos	`examples/`

SDKs

Language	Package	Install
TypeScript	`@mindburn/helm-ai-enterprise-sdk`	`npm install @mindburn/helm-ai-enterprise-sdk`
Python	`helm-ai-kernel-sdk`	`pip install helm-ai-kernel-sdk`
Go	`github.com/Mindburn-Labs/helm-ai-enterprise/sdk/go`	`go get ...`
Rust	`helm-ai-kernel-sdk`	`cargo add helm-ai-kernel-sdk`
Java	`ai.mindburn.helm:helm-ai-kernel-sdk`	Maven

CI Gates

Gate	Script	What it checks
SDK drift	`scripts/ci/sdk_drift_check.sh`	Regenerate → diff = fail
SDK build/test	`scripts/ci/sdk_build_test.sh`	Build + test all 5 SDKs
OpenAPI lint	`.github/workflows/sdk_gates.yml`	Redocly lint

Per-SDK READMEs

TypeScript (protected staff doc)
Python (protected staff doc)
Go (protected staff doc)
Rust (protected staff doc)
Java (protected staff doc)

Diagram

Diagram1. Ingestion & Context Plane -> HELM SDK Documentation -> Architecture -> Contract → Code → Wrapper → Example -> SDKs -> Reader outcome -> 2. Evaluation & Policy Plane -> CI Gates

flowchart TD
    subgraph Ingestion["1. Ingestion & Context Plane"]
        source["HELM SDK Documentation"]
        s0["Architecture"]
        s1["Contract → Code → Wrapper → Example"]
        s2["SDKs"]
        output["Reader outcome"]
    end

    subgraph Evaluation["2. Evaluation & Policy Plane"]
        s3["CI Gates"]
    end

    %% Operational Flow Edges
    source --> s0
    s0 --> s1
    s1 --> s2
    s2 --> s3
    s3 --> output

    %% Premium Styling Rules
    style s3 fill:#2d3748,stroke:#4a5568,stroke-width:2px,color:#fff

Mermaid source

flowchart TD
    subgraph Ingestion["1. Ingestion & Context Plane"]
        source["HELM SDK Documentation"]
        s0["Architecture"]
        s1["Contract → Code → Wrapper → Example"]
        s2["SDKs"]
        output["Reader outcome"]
    end

    subgraph Evaluation["2. Evaluation & Policy Plane"]
        s3["CI Gates"]
    end

    %% Operational Flow Edges
    source --> s0
    s0 --> s1
    s1 --> s2
    s2 --> s3
    s3 --> output

    %% Premium Styling Rules
    style s3 fill:#2d3748,stroke:#4a5568,stroke-width:2px,color:#fff

Operational Readiness

Use this page as the public operating layer for SDK Documentation. The source of truth is helm-ai-enterprise/docs/public/reference/sdks/index.md; if this page and the implementation disagree, update the source-backed doc and rerun the validation command before publishing.

Before relying on this surface, confirm three things: the source path above still exists, the referenced commands or contracts are still present in the owning repo, and the docs-platform export surfaces still show this page in search, Markdown, llms-full.txt, and MCP without exposing protected routes.

Validation command: corepack pnpm run docs:coverage && corepack pnpm run docs:truth. For website parity, also run npm run exports:boundary and npm run thin-pages:check from docs-platform.

Expected Output

A reader should leave with a concrete next action, the source file or contract to inspect, the command that proves the claim, and a clear boundary for what is public versus protected. For reference pages, the expected output is a correctly scoped request, schema, command, or diagnostic path. For operations pages, the expected output is a reproducible readiness or failure signal that can be attached to an evaluation or support thread.

Failure Modes

If the validation command fails, do not patch this page in isolation. First identify whether the drift is in code, generated contracts, source-owner docs, or the docs manifest. If the public page needs a protected deep link, describe the protected document by name instead of exposing its route. Commercial operator details, tenant data, key ceremonies, and deployment-sensitive internals stay in protected customer or staff docs; this public page only exposes the safe developer contract.