REST API

Overview

High-performance HTTP REST API reference for authentication, entity CRUD operations, declarative graph queries, custom workflows, and file storage.

The Kodall REST API handles CRUD (Create, Retrieve, Update, Delete) operations for all entities, data retrieval via the declarative FETCH query engine, execution of server-side workflows, and file storage management.

Client SDKs

Client libraries for interacting with the Kodall REST API:

BASH

npm i @kodall/kodall-client

TYPESCRIPT

import { KodallClient } from '@kodall/kodall-client'

// Initialize with an API key (stateless)
const client = new KodallClient({
  baseUrl: 'https://docs-demo.kodall.io',
  apiKey: 'your-api-key'
})

// Or in a browser session (stateful cookies)
const sessionClient = new KodallClient({
  baseUrl: 'https://docs-demo.kodall.io'
})

BASH

pip install kodall-client

PYTHON

from kodall_client import KodallClient

# Initialize client with API key (stateless)
with KodallClient(base_url="https://docs-demo.kodall.io", api_key="your-api-key") as client:
    todos = client.fetch("FETCH todo (key, title)")
    print(todos)

XML

<dependency>
    <groupId>kodall</groupId>
    <artifactId>kodall-client-java</artifactId>
    <version>1.0.0-SNAPSHOT</version>
</dependency>

JAVA

import kodall.client.KodallClient;
import kodall.client.KodallClientConfig;

// Initialize client with API key
KodallClientConfig config = KodallClientConfig.newBuilder()
        .baseUrl("https://docs-demo.kodall.io")
        .apiKey("your-api-key")
        .build();

KodallClient client = new KodallClient(config);

BASH

dotnet add package Kodall.Sdk

CSHARP

using Kodall.Sdk;

var client = new KodallClient(new KodallClientOptions
{
    BaseUrl = "https://docs-demo.kodall.io",
    ApiKey = "your-api-key"
});

API Functional Areas

Area	Description	Documentation
Auth API	Session tokens, login, profiles, password changes, and logout.	Auth API
Entities API	Strongly-typed CRUD operations and child entity hierarchy management.	Entities API
Fetch API	Graph query execution, AST parsing, and metadata inspection.	Fetch API
Workflow API	Execution of server-side workflow rules, methods, and calculations.	Workflow API
Storage API	Upload, versioning, download, and streaming of storage files.	Storage API
Security	Authentication scopes, ACL permissions, and CSRF protection.	Security Architecture

SolidJS

Step-by-step guide to building, proxying, and deploying static SolidJS applications to a Kodall instance with @kodall/kodall-deploy.

Auth API

The Auth API provides session and server information and enables the creation of reusable session cookies, unlike the stateless access offered by API key authentication.