Documentation

Install, build, and operate Sirius. How-to guides cover the console. The REST and Studio API pages are the contract your scripts and CI will call. Written for the website — not a dump of internal engineering notes.

Get started

• Introduction — what Sirius is and how the pieces fit.
• Quick start — install, map, save, run.
• Install — one-command Compose stack.
• Core concepts — integrations, messages, the three APIs.

Build

• Build an integration — canvas, runtime, versions.
• Studio — languages, samples, tests, milestones.
• Connectors — HTTP, queues, standards, devices.
• Migrate — native conversion from any engine.

How-to

• Build a flow — source, transform, destination, start.
• Write a transform — Studio loop from sample to milestone.
• Add a connector — register, probe, bind.
• Replay a message — ledger replay and the dead-letter queue.
• Watch the runtime — dashboard, logs, retention.
• Page on failure — rules, channels, instances.
• Issue an API token — revocable sk_ bearers for CI.
• Sessions and refresh tokens — local console login without an IdP.
• Connect an identity provider — OIDC, groups, break-glass.
• Export and import — portable packages, secret refs only.
• Restore a version — fork a draft or reactivate a build.
• Migrate a script — native translation and the unmapped report.
• Run a long-running process — import BPMN, wait, resume.
• Build a streaming topology — stages, windows, live drive.
• Use the in-product agent — skills, tools, MCP.

APIs

• REST API — auth, tenancy, errors, conventions.
• REST resources — domain map and representative routes.
• REST identity — sessions, tokens, IdP, RBAC.
• REST operations — messages, logs, alerts, dashboard.
• REST advanced — codecs, BPMN, streams, migration, agent.
• REST recipes — curl, Python, and JavaScript.
• Studio API — workspaces, runs, tests, promotions.
• Studio projects — files, samples, fixtures.
• Studio runs — execute, assert, SQL, WASM.
• Studio recipes — end-to-end Studio examples.
• Host API — sirius.* contract and family index (249 symbols).
• Host API — core — text, JSON, dates, crypto, codecs, XML, node.stg.
• Host API — standards — HL7, FHIR, X12, ISO 20022, FIX, and more.
• Host API — I/O — HTTP, databases, files, routing, store, AI.
• Host API — devices — MQTT, CoAP, OPC UA, BACnet, SIP, SMPP.

Operate

• Deploy — Compose, Kubernetes, HTTPS, upgrades.
• Operate — monitor, replay, alerts, HA.
• High availability — topologies, leadership, and what you run outside Sirius.
• Security — identity, RBAC, secrets, audit.