Skip to main content

SDK Reference

The Orkestra SDK (github.com/orkestra-cc/orkestra-sdk) is the public contract every module — core or addon — programs against. It defines:

  • The Module lifecycle interface (Init, RegisterRoutes, Start, Stop, HealthCheck).
  • The ServiceRegistry — a typed key-value store for cross-module service sharing.
  • The ConfigService — DB-backed + Redis-cached config with AES-256-GCM-encrypted secrets.
  • The shared/iface consumer-facing interfaces (UserProvider, NotificationSender, PDFProvider, GraphProvider, AIModelProvider, RAGQueryProvider, JWTProvider) that prevent direct cross-module imports.

Module status​

ItemValue
Module pathgithub.com/orkestra-cc/orkestra-sdk
Latest versionv0.4.0
Repoorkestra-cc/orkestra-sdk

Build your first addon​

See Build your first addon.