Skip to main content
Modules are the primary way to extend the Kodexa platform with custom logic. Whether you need to process documents, extract data, handle events, or provide prompts and knowledge to agents, you’ll build a module. There are three types of modules:

Python Modules

Executable Python code that processes documents, runs inference, and handles events. Used with scheduled jobs, pipelines, and assistants.

JavaScript Modules

Inline JavaScript scripts for lightweight processing. Fast to deploy, ideal for transformations, routing, and API calls.

Skill Modules

File packs containing prompts, configurations, and knowledge that agents can discover and use.

Quick Comparison

Python ModuleJavaScript ModuleSkill Module
moduleTypemodel (default)model (default)skill
ContainsPython codeInline JS scriptFiles (prompts, configs, knowledge)
ExecutionRuns via Python module runtimeRuns via Go scripting runtimeNot executed — read by agent
Used byScheduled jobs, pipelines, assistantsScheduled jobs, pipelines, assistantsAgents
Runtime refkodexa/base-module-runtimekodexa/go-scripting-runtimeNot needed

Prerequisites

Before building any module, ensure you have:
  1. Python 3.11+ installed
  2. KDX CLI installed and configured — see Installation
  3. Kodexa Python SDKpip install kodexa
  4. A Kodexa platform account with an organization

Deployment

Both module types are deployed the same way using kdx apply:
kdx apply -f module.yml
This command creates or updates the module metadata and uploads your code/files in one step. See Resource Operations for more details.