SDK & REST API

Build frontend web applications, backend services, and automated integrations using Kodall client SDKs and the REST API.

Welcome to the Kodall SDK & REST API Reference. This documentation is structured according to the Diátaxis Framework across four core quadrants: Tutorials (guided lessons), How-To Guides (practical recipes), Reference (authoritative technical specs), and Explanation (architectural concepts).

Documentation by Developer Need

Find the recommended starting point based on your current objective:

Learning to build & deploy a frontend application? (Tutorials)
Follow step-by-step guides to configure local development proxies, initialize client state, and deploy to Kodall:
Nuxt | Vue 3 | React | Next.js | Angular | SvelteKit | SolidJS
Solving a specific integration task? (How-To Guides)
Follow actionable recipes for common operational and development problems:
Looking for API schemas, CLI flags, or types? (Reference)
Consult complete, authoritative technical specifications:
Understanding architecture & security design? (Explanation)
Understand why and how the platform functions:
- Zero-Server Web App Deployment Architecture
- Platform Security & Authentication Architecture

Client SDKs

Kodall provides first-party client libraries designed for performance, developer ergonomics, and complete platform feature coverage. Each SDK offers strongly typed entity models, declarative Fetch querying, workflow execution, file storage streaming, and flexible stateless (API key) or stateful (session cookie) authentication.

TypeScript SDK

Client library for TypeScript, JavaScript, Node.js, Bun, Deno, and modern browser runtimes with runtime type guards and query builders.

Python SDK

Modern, typed Python 3.10+ client built on httpx with domain services, scoped entity helpers, and context manager support.

Java SDK (Java 21+)

Zero-dependency, high-performance vanilla Java 21 client library leveraging JDK 21 HttpClient and Java Records mapping.

.NET SDK

Client library for .NET 6+ and C# applications with DataContract serialization, entity CRUD operations, and workflow triggers.

Web App Deployment

The @kodall/kodall-deploy developer toolkit allows you to package and host any static Single Page Application bundle directly inside a Kodall instance. By serving compiled web assets through Kodall's internal storage and gateway engine, your application runs on the exact same origin as the backend API, completely eliminating CORS preflights and enabling automatic session cookie propagation without credentials configuration.

Core Tooling & Architecture

Deployment Overview

Architecture guide, same-origin benefits, universal static web hosting, and gateway storage streaming.

kodall-deploy Tooling & CLI

Command-line deployment tool, configuration schema (kodall-webapp.config.json), environment switcher (use), and CLI flags reference.

Local Dev Proxy Suite

Native development proxy helpers for Vite, Nuxt, Next.js, and Angular with automatic instance resolution and custom proxy paths.

CI/CD & Automation

Automated CI/CD pipeline generation (--init-ci), live health checks, instant rollbacks, and the Programmatic TypeScript API.

Framework Integration Guides

Kodall natively hosts any static Single Page Application. Explore our reference integration guides for popular frontend frameworks:

Nuxt 3/4

Step-by-step guide for static SPA generation with Nuxt, Nitro development proxying, useKodall composable, and deployment.

Vue 3 (Vite)

Standalone Vue 3 SPA setup with Vite development proxy, client composables, parent-child entity bindings, and deployment.

React (Vite)

Build and deploy React Single Page Applications with Vite proxy, anti-flicker session restore, and file storage uploads.

Next.js (Static Export)

Configure Next.js with output: 'export', local development API rewrites, client components, and deployment pipelines.

Angular (17+)

Modern Angular standalone applications with Signals-based session state, proxy.conf.json forwarding, and deployment.

SvelteKit

Static SPA export using @sveltejs/adapter-static with fallback routing, Vite dev proxy, and automated Kodall deployment.

SolidJS

Reactive SolidJS Single Page Applications with vite-plugin-solid, local dev proxying, and deployment configuration.

REST API Reference

The Kodall REST API exposes the full power of the core platform over standard HTTP web endpoints. Developers can perform entity CRUD mutations, execute graph traversal queries via the FETCH query language, invoke server-side workflows, and upload or version files with fine-grained role-based security enforcement.

REST API Overview

Interactive API overview, authentication scopes, client library matrix, and live HTTP endpoint execution.

Auth API

Session creation, credential login, OpenID Connect / OAuth2 tokens, active profile switching, and logout lifecycle.

Entities API

Direct CRUD operations for business entities, property mutations, and atomic parent-child record persistence.

Fetch API

Declarative graph queries, projection filtering, sorting, pagination, query AST parsing, and column metadata inspection.

Workflow API

Trigger server-side workflow rules, custom calculation routines, and background automation methods by name.

Storage API

Multipart and binary file upload, version history tracking, metadata inspection, and streaming download endpoints.

Security Architecture

Security foundation, API key hashing, Role-Based Access Control (RBAC), and Row-Level Security (RLS) enforcement.