API Reference

Auto-generated API documentation from the Kailash SDK source code.

• Workflow
  • Workflow Class
  • WorkflowBuilder
  • Workflow Graph Management
  • Cyclic Workflows (Enhanced in v0.2.0)
  • WorkflowRunner
  • State Management
  • Workflow Patterns
  • Workflow Visualization
  • Workflow Serialization
  • Best Practices
  • Cycle Configuration (New in v0.2.0)
  • Migration Tools (New in v0.2.0)
  • See Also
• Runtime
  • Overview
  • Runtime Selection
  • LocalRuntime
  • AsyncLocalRuntime
  • BaseRuntime
  • Trust Runtime
  • Durable Execution & Distributed Dispatch (v2.14.0+)
  • CyclicWorkflowExecutor
  • ParallelCyclicRuntime
  • ParallelRuntime
  • DockerRuntime
  • TestingRuntime
  • Runtime Comparison
  • Custom Runtime Development
  • Performance Optimization
  • Error Handling
  • Monitoring and Metrics
  • See Also
• Nodes
  • Base Node Classes
  • Data Nodes
  • Transform Nodes
  • Logic Nodes
  • AI/ML Nodes
  • API Nodes
  • MCP Nodes
  • Alert Nodes
  • Code Nodes
  • Custom Node Development
  • Node Configuration Best Practices
  • See Also
• Workflow API Wrapper
  • Overview
  • Core Components
  • Request/Response Models
  • Usage Examples
  • Production Deployment
  • Advanced Features
  • Specialized APIs
  • Best Practices
  • See Also
• Middleware Components
  • Overview
  • Core Components
  • Event System
  • Authentication & Security
  • MCP Integration
  • Database Layer
  • Schema Generation
  • Usage Patterns
  • Migration Guide
  • Performance Considerations
  • Testing
  • Related Documentation
• Access Control
  • Access Control Manager
  • User Context
  • Permission Rules
  • Access Decisions
  • Enumerations
  • Access Controlled Runtime
  • Base Nodes with ACL
  • Examples
• Tracking
  • Overview
  • TaskManager
  • Tracking Models
  • Storage Backends
  • Tracking Configuration
  • Analytics and Reporting
  • Real-time Monitoring
  • Performance Metrics Collection
  • Performance Visualization
  • Best Practices
  • See Also
• Monitoring & Alerting API
  • ValidationMetrics
  • SecurityMetrics
  • PerformanceMetrics
  • AlertManager
  • AlertRule
  • AlertSeverity
  • AsyncSQLMetrics
  • enable_metrics()
  • disable_metrics()
  • get_global_metrics()
  • set_global_metrics()
  • record_lock_acquisition()
  • record_pool_operation()
  • set_active_locks()
  • integrate_with_async_sql()
  • Metrics Collection
  • Alert Management
  • Usage Examples
• Visualization
  • Overview
  • Real-time Dashboard
  • Dashboard Configuration
  • Live Metrics
  • Performance Reporter
  • Report Formats
  • Performance Insights
  • Dashboard API
  • WebSocket Server
  • Performance Visualizer
  • Usage Examples
  • Dashboard Features
  • Architecture
  • Best Practices
• Utils
  • Export Utilities
  • Hierarchical RAG Utilities
  • Node Registry Utilities
  • Configuration Utilities
  • Visualization Utilities
  • Performance Utilities
  • Testing Utilities
  • See Also
• CLI
  • Overview
  • Installation
  • Basic Usage
  • CLI Commands
  • Configuration
  • Extending the CLI
  • Best Practices
  • See Also

Core SDK

Workflow

kailash.workflow.builder.WorkflowBuilder([...])

Builder pattern for creating Workflow instances.

Runtime

kailash.runtime.local.LocalRuntime([debug, ...])	Unified runtime with enterprise capabilities.
kailash.runtime.async_local.AsyncLocalRuntime([...])	Async-optimized runtime for Kailash workflows.
kailash.runtime.base.BaseRuntime([debug, ...])	Base class for all workflow runtimes.

Trust

kailash.runtime.trust

Trust context module for Kailash runtime (CARE-015, CARE-016, CARE-018).

Nodes

See Nodes for the complete node reference covering 140+ node types organized by category (AI, API, Code, Data, Database, Logic, Monitoring, Transaction, Transform).

Frameworks

Kaizen (v1.2.1)

from kaizen.api import Agent
from kaizen.core.base_agent import BaseAgent
from kaizen.core.registry import AgentRegistry

See Kaizen – AI Agent Framework for framework documentation.

Nexus (v1.4.1)

from nexus import Nexus
from nexus.auth.plugin import NexusAuthPlugin, JWTConfig, TenantConfig

See Nexus – Multi-Channel Platform for framework documentation.

DataFlow (v0.12.1)

from dataflow import DataFlow

See DataFlow – Database Framework for framework documentation.

Import Quick Reference

# Core SDK
from kailash.workflow.builder import WorkflowBuilder
from kailash.runtime import LocalRuntime, AsyncLocalRuntime, get_runtime
from kailash.runtime.trust import (
    RuntimeTrustContext,
    TrustVerificationMode,
    TrustVerifier,
    TrustVerifierConfig,
)
from kailash.nodes.base import BaseNode, AsyncNode, NodeParameter

# Kaizen (AI Agents)
from kaizen.api import Agent
from kaizen.core.base_agent import BaseAgent
from kaizen.core.registry import AgentRegistry

# Nexus (Multi-Channel)
from nexus import Nexus
from nexus.auth.plugin import NexusAuthPlugin, JWTConfig, TenantConfig

# DataFlow (Database)
from dataflow import DataFlow