SDKs

Python SDK

The official Python client is published on PyPI as cascades-sdk (import namespace cascades_sdk). Source code, issues, and release engineering live in the no1rstack/cascades-sdk repository on GitHub (canonical URL: https://github.com/no1rstack/cascades-sdk).

pip install cascades-sdk

• PyPI: https://pypi.org/project/cascades-sdk
• GitHub: https://github.com/no1rstack/cascades-sdk
• Platform app (this repo): https://github.com/no1rstack/cascades — ships the authoritative HTTP contract at contracts/api.yaml

JavaScript / TypeScript (npm)

For Node and browser tooling, install the scoped package that ships the mirrored contracts/api.yaml, LICENSE, and a small ESM entry:

npm i @noirstack/cascades-sdk

• npm: https://www.npmjs.com/package/@noirstack/cascades-sdk
• PyPI (Python client): https://pypi.org/project/cascades-sdk
• Source / releases: https://github.com/no1rstack/cascades-sdk

Authentication with this deployment

• Default: Integrators authenticate using browser session cookies after Sign-In (Auth0-backed sessions). Copy the Cookie header from an authenticated browser session — typically including __session (exact cookie names may vary per deployment).
• Optional / roadmap: Some tenants may expose programmatic auth (for example bearer tokens or service identities). When documented for your environment, supply those credentials via the SDK’s HeaderAuth or custom AuthProvider implementations — see the client module in cascades-sdk on GitHub.

Integrators maintaining forks should track the canonical HTTP boundary in the Cascades platform repository (contracts/api.yaml), kept aligned with this deployment’s /openapi.json for workflow submission (POST /api/workflows/run) and run telemetry (GET /api/runs/{id}/stream). The cascades-sdk repo should mirror that boundary for each PyPI release.

The Cascades SDK lives in its own repository and follows the same Business Source License 1.1 (BUSL 1.1) as this platform. See the SDK’s LICENSE and Licensing for parameters, permitted use, and commercial terms.

HTTP APIs today

Teams can integrate with this deployment using:

• OpenAPI contract — machine-readable spec and /openapi.json usage
• Download OpenAPI JSON — raw document for codegen and CI
• API Reference — interactive explorer
• Direct REST calls, webhooks, and internal tooling

Generated clients & roadmap

Use the OpenAPI document with generators (OpenAPI Generator, Kiota, etc.) for languages beyond Python where needed. npm i @noirstack/cascades-sdk covers the contract bundle for JS/TS workflows; pip install cascades-sdk remains the full Python client on PyPI.

Additional first-party typed clients may ship over time; announcements appear via Noir Stack, Discord (Cascades announcements), and community.noirstack.com.