About Kinesis API

A powerful, all-in-one framework that transforms how you create, manage, and scale APIs. Kinesis API is designed to simplify complex API development workflows while maintaining professional-grade capabilities. Think of it as an API to make APIs—dramatically accelerating development without sacrificing quality or control.

What is Kinesis API?

Kinesis API is a comprehensive platform that combines a visual API builder, embedded database system, and full-featured content management into a single cohesive solution. Whether you're prototyping a simple API or building complex, interconnected systems, Kinesis API provides the tools to accelerate development while maintaining complete control over your infrastructure.

Key Features
  • Visual API Builder (X Engine): Create APIs without writing backend code using an intuitive flow-based system (Learn more)
  • Embedded Database: High-performance, ACID-compliant database with multiple storage engines (Learn more)
  • Content Management: Built-in blogging platform with Markdown support and user engagement features (Learn more)
  • Localization Engine: Multi-language support with variable interpolation and pluralization (Learn more)
  • Search Engine: Powerful filtering capabilities with an intuitive query language (Learn more)
  • User Management: Role-based access control with 2FA/OTP support (Learn more)
  • Media Management: Integrated file storage and serving capabilities (Learn more)
  • Backup & Restore: Automated backup scheduling with compression and recovery (Learn more)
  • Version Control: Content history tracking for routes, data objects, and blog posts (Learn more)
  • Component Metrics: Detailed analytics for blog posts, snippets, and redirects (Learn more)
  • Ticketing System: Issue tracking with email notifications and assignee management (Learn more)
  • Interactive REPL: Real-time database interaction and testing (Learn more)
Project Status

Kinesis API is currently in active development with version 0.35.0. The platform is production-ready for many use cases, though you should expect occasional breaking changes until the 1.0.0 release. Core functionality is extensively tested and stable. The API documentation is available at api.kinesis.world/scalar, or locally on the /scalar endpoint.

Backend Stack
  • Rocket: Fast, type-safe web framework for Rust
  • Tera: Powerful template engine inspired by Jinja2
  • Serde: High-performance serialization framework
  • Lettre: Email handling library for notifications
  • utoipa: OpenAPI documentation generator
  • Diesel: ORM for external database support
  • MaxMind GeoIP2: Geographic IP address lookup
  • Kinesis DB: Custom-built ACID-compliant embedded database
Frontend Stack
Kinesis API Schema
Note: The database schema diagram shown above is outdated and does not reflect the current structure of Kinesis API. It is kept here for historical reference. For the most up-to-date information about the database structure, please refer to the Kinesis DB documentation.
Kinesis DB: Custom Database System

Kinesis API includes a high-performance, ACID-compliant embedded database built from scratch in Rust. This eliminates dependencies on external database systems, reducing potential points of failure and providing significant performance advantages through memory-mapped I/O and optimized caching strategies. For comprehensive technical details, see the Kinesis DB documentation and technical reference.

Multiple Storage Engines

  • In-Memory: Ultra-fast, volatile storage for temporary data and caching
  • On-Disk: Durable storage with ACID guarantees for critical data
  • Hybrid: Intelligent caching with persistent backing for balanced performance

Schema Management

  • Flexible schema creation and runtime updates
  • Strong type system with field constraints
  • Support for required fields, unique constraints, and default values
  • Pattern matching for string fields using regular expressions

Transaction Support

  • Full ACID compliance (Atomicity, Consistency, Isolation, Durability)
  • Multiple isolation levels (ReadUncommitted, ReadCommitted, RepeatableRead, Serializable)
  • Deadlock detection and prevention
  • Write-Ahead Logging (WAL) for crash recovery

Performance Optimizations

  • Memory-mapped I/O for ultra-fast read/write operations
  • Configurable buffer pool management
  • Automatic blob storage for large string values
  • Asynchronous I/O operations for concurrent access
X Engine: Visual API Builder

The X Engine is the most sophisticated component of Kinesis API, enabling users to design and deploy custom APIs through a visual flow-based system. For detailed information about blocks, processors, and building complex workflows, see the X Engine documentation and tutorials. The engine uses a modular architecture consisting of:

  • Processors: Handle execution flow including loops, conditional logic, and control signals (return/break/fail)
  • Resolvers: Map requests to appropriate data sources and transform inputs dynamically
  • Convertors: Transform data between different formats for input/output processing
  • Definitions: Define the expected result format for each "block" that makes up a custom API
  • Blocks: Pre-built operations for data manipulation, validation, API calls, and more
Multi-Database Support

Kinesis API supports multiple database backends, giving you flexibility in choosing the storage solution that best fits your needs. Learn more about database backends and migration:

  • Kinesis DB: Custom embedded database (default) with optimal performance and zero external dependencies
  • SQLite: Lightweight, file-based relational database for simple deployments
  • MySQL: Popular open-source relational database for enterprise environments
  • PostgreSQL: Advanced open-source relational database with extensive features

The platform includes a migration utility for seamless data transfer between different database backends, accessible through both the API and Web UI.

Configuration & Deployment

Kinesis API can be configured through environment variables and deployed in various ways. See the installation guide and configuration reference for details:

  • Docker: Official multi-platform Docker images available for quick deployment
  • Binary: Standalone executables for direct deployment on your infrastructure
  • Source: Build from source for custom configurations and development

Comprehensive documentation covers installation, configuration, and best practices for production deployments. Visit our documentation hub to get started.

Credits & Acknowledgments

Kinesis API is built upon the work of many open-source projects and libraries. We are grateful to the maintainers and contributors of:

Core Backend Dependencies

  • Rocket framework and ecosystem for web server functionality
  • Tera template engine for server-side rendering
  • Serde for serialization and deserialization
  • Diesel ORM for database abstraction
  • Lettre for email delivery
  • utoipa and utoipa-scalar for API documentation generation
  • Tokio for async runtime and scheduling
  • Various Rust crates for cryptography, compression, and utilities

Frontend Libraries & Tools

  • Tailwind CSS and DaisyUI for styling and components
  • Remix Icon for the icon library
  • Google Fonts (Jost and Montserrat) for typography
  • Markdown-it and plugins for Markdown rendering
  • PrismJS for syntax highlighting
  • MermaidJS for diagram generation
  • Chart.js with Luxon adapter for data visualization
  • Leaflet for interactive maps
  • JMESPath for JSON querying

Data & Analytics

  • MaxMind GeoIP2 database for geographic location detection
  • User Agent Parser with UAP regexes for browser/device detection
  • Chart.js Matrix plugin for heatmap visualizations

Special thanks to the Rust community and all open-source contributors whose work makes projects like Kinesis API possible.

Made with from Mauritius