Documentation Index
Fetch the complete documentation index at: https://developer.kodexa.ai/llms.txt
Use this file to discover all available pages before exploring further.
Welcome to Kodexa
Kodexa is a platform for running document-heavy business processes where automated work, human review, business knowledge, integrations, and audit history need to stay aligned. It gives teams a shared model for turning unstructured documents into governed workflows that can be configured, reviewed, versioned, and reused.Documentation Structure
This developer portal is organized into the following sections, each designed to help you at different stages of your journey with Kodexa:Welcome
Start here for an overview of the platform and recent changes
Concepts
Understand the Activity and Task mental model for document-heavy business workflows
CLI Tools
Command-line tools for local development, GitOps workflows, and infrastructure management
SDK
Python and TypeScript SDKs for working with Kodexa Documents programmatically
Guides
In-depth guides for Activity Plans, data definitions, event scripting, service bridges, and review forms
API Reference
Complete REST API documentation for programmatic access to all platform features
Where to Start
New to Kodexa?
Learn the Document Model
Read What is a Kodexa Document? to understand the KDDB format, content nodes, tags, and how data extraction works. Then explore the Document Structure Deep Dive for a detailed walkthrough.
Model the Data
Learn Data Definitions to describe the business objects, fields, types, and relationships you want Kodexa to extract and validate.
Understand Activities and Tasks
Use Concepts to learn how Activities model automated business process runs and Tasks model the human review work inside those processes.
Design the Review Experience
Learn Data Forms to see how extracted data is presented for review, correction, validation, and task completion.
Build Your First Project
Start with Projects and Project templates to bind documents, data definitions, Activity Plans, review forms, and permissions into a working business workflow.
Building Production Applications?
GitOps Deployment
Automate deployments with GitHub Actions, multi-environment promotion, and PR validation
KDX CLI
Manage resources, sync metadata, and control your Kodexa infrastructure from the command line
API Integration
Integrate Kodexa into your applications with our comprehensive REST API
Data Forms
Build custom UIs for document review, validation, and data extraction
Working with Specific Features?
Document Processing & Modules
Document Processing & Modules
- Documents - Understanding document structure and content
- Modules - Training and deploying ML modules
- Working with Modules - Practical module usage
- Module Runtimes - Deployment and scaling
Storage & Data
Storage & Data
- Document Stores - Persistent document storage
- Data Stores - Structured data storage
- Storage Overview - Platform storage architecture
- Data Definitions - Business data models, validation rules, formulas, and event scripts
Knowledge & Intelligence
Knowledge & Intelligence
- Knowledge Systems - Building intelligent rule systems
- Formulas - Dynamic calculations and transformations
- Activity Plans - Automated process runs with scripts, bridge calls, LLM steps, and human review handoffs
Infrastructure & Deployment
Infrastructure & Deployment
- Deployment Overview - GitOps workflows
- Resource Operations - Managing platform resources
- Metadata Sync - Version control for configurations
Platform Capabilities
Kodexa’s capabilities are organized around the way real work happens: an Activity runs the business process, Tasks bring people into that process, and shared platform resources keep the documents, data, knowledge, integrations, and deployments consistent across projects.Activity Orchestration
Model business processes as reusable Activity Plans with steps for extraction, scripts, Service Bridges, LLM calls, approvals, and Task handoffs.
Human Review Tasks
Create review, approval, exception, and correction work when an Activity needs human judgment or accountability.
Data Definitions
Define business objects, attributes, types, relationships, selection options, formulas, validation rules, and event-based scripts.
Data Forms
Build Task review experiences that bind extracted data, document context, exceptions, validation messages, and completion actions.
Kodexa Document Model
Work with KDDB documents, content nodes, tags, labels, exceptions, data objects, metadata, and provenance.
Knowledge & Intelligence
Capture reusable knowledge, feature types, rules, examples, prompts, and AI context that shape extraction and decisions.
Integrations & Service Bridges
Connect Activities and scripts to external systems for lookups, enrichment, validation, notifications, and posting results.
CLI, SDK & API
Manage resources with the KDX CLI, version-controlled metadata, SDKs, REST APIs, GitOps deployment, and environment promotion.
| Capability layer | What it owns |
|---|---|
| Activity | The automated business process run |
| Task | The human work created inside the process |
| Data Definition | The business data model, validation behavior, and event hooks |
| Data Form | The reviewer experience for task completion |
| Project | The bound set of documents, definitions, activities, forms, users, and permissions |
Need Help?
Contact Us
Get in touch with our team for personalized assistance