Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 1.98 KB

README.md

File metadata and controls

49 lines (33 loc) · 1.98 KB

IgnitionRAG SDK

CI npm license

Official open-source TypeScript SDK and signed public API contracts for IgnitionRAG deployments.

IgnitionRAG itself is licensed software. This repository contains client libraries only; it does not contain the product server, administration CLI, widgets, deployment tooling, customer configuration, or private MCP implementations.

TypeScript

bun add @ignitionai/sdk@next
# or npm install @ignitionai/sdk@next

This source tree prepares 1.0.0 for public contract 2026.11; publication requires the reviewed release workflow. ingest.file is a breaking change from 0.3.0-rc.4. The unqualified install command remains on the stable 0.2.x line until 1.0.0 is promoted to latest.

import { IgnitionAI } from "@ignitionai/sdk";

const ignition = new IgnitionAI({
  baseURL: "https://rag.example.com",
  apiKey: process.env.IGNITION_API_KEY,
});

const collections = await ignition.collections.list();

See the TypeScript SDK guide for server, browser, streaming, workflow and deep-research examples.

Repository layout

  • typescript/ — the supported TypeScript SDK.
  • contracts/ — signed, versioned public API artifacts and trusted verification keys.
  • examples/ — minimal runtime smoke examples.
  • docs/ — compatibility and release documentation.

Security

API keys are server-side credentials. Browser applications must use @ignitionai/sdk/browser with a delegated token provider. See SECURITY.md to report a vulnerability privately.

License

SDK source code is released under the MIT License. This license does not grant rights to the private IgnitionRAG product.