The Conway Automaton TypeScript API provides programmatic access to the core runtime, state management, and configuration systems. Use these APIs to build custom tools, extend agent capabilities, and integrate with the automaton’s lifecycle.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/Conway-Research/automaton/llms.txt
Use this file to discover all available pages before exploring further.
Installation
The TypeScript API is bundled with the Conway Automaton runtime:Core Modules
The API is organized into three primary modules:Configuration
Load, save, and manage automaton configuration
Database
SQLite-backed state management and persistence
Types
TypeScript interfaces and type definitions
Quick Start
Import Core APIs
Load Configuration
Access Database
Architecture
The TypeScript API follows these design principles:Type Safety
All public APIs are fully typed with TypeScript interfaces. The runtime enforces type checking at compile time and validation at runtime.Immutable Configuration
Configuration is loaded from~/.automaton/automaton.json and merged with defaults. Changes must be explicitly saved:
SQLite-Backed State
All runtime state is stored in a SQLite database with automatic schema migrations:- Turns: Agent reasoning and tool execution history
- Transactions: Financial state and credit balance
- Skills: Installed capabilities and instructions
- Children: Spawned child automatons and their lifecycle
- Memory: Working, episodic, semantic, and procedural memory
Transaction Support
Database operations support atomic transactions:Common Patterns
Reading Recent History
Managing Financial State
Tracking Children
API Stability
The TypeScript API follows semantic versioning:- Breaking changes: Major version bump (v1 → v2)
- New features: Minor version bump (v1.0 → v1.1)
- Bug fixes: Patch version bump (v1.0.0 → v1.0.1)
Next Steps
Configuration API
Load and manage automaton configuration
Database API
Access persistent state and memory