Skip to content

IgnitionAI/sdk

Repository files navigation

IgnitionRAG SDK

CI npm license

Official open-source SDKs 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

The current public release is 0.3.0-rc.3 under the npm next tag. The unqualified install command remains on the stable 0.2.x line until 0.3.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.

The Python SDK may be added later. It is not part of the current support commitment.

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.

About

Official MIT SDKs and signed public API contracts for IgnitionRAG

Topics

Resources

License

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors