Skip to main content

ValkyrAI Documentation

Welcome to the official documentation for ValkyrAI, an innovative platform that leverages artificial intelligence to streamline and automate business processes. Built on the robust capabilities of ThorAPI, ValkyrAI accelerates the development of secure and efficient APIs by transforming OpenAPI specifications into fully-functional backend and frontend codebases.

What is ValkyrAI?​

ValkyrAI is an AI-powered Java Business Process Management (WORKFLOW) platform that serves as your trusty sidekick in the world of business processes—always ready to help you streamline and automate! With ValkyrAI, developers can rapidly generate Java Spring Boot services and TypeScript clients, significantly reducing development time while maintaining high standards of code quality and security.

Documentation Sections​

This documentation is organized into the following sections:

  • Overview - Learn about ValkyrAI's purpose, architecture, and key concepts
  • Getting Started - Set up your environment and create your first ValkyrAI project
  • Developers Guide - Comprehensive guide for developers working with ValkyrAI
  • Workflow Engine - Learn about ValkyrAI's powerful workflow automation capabilities
  • SecureFieldKMS - Understand ValkyrAI's built-in key management system
  • Model Context Protocol - Explore ValkyrAI's implementation of the Model Context Protocol
  • Utilities - Discover the various utilities included with ValkyrAI

Key Features​

ValkyrAI offers a wide range of features designed to enhance business process management and automation:

  • Workflow Management: Create, start, stop, and monitor workflows through a dedicated API
  • Task Management: Create and manage tasks associated with workflows
  • Execution Modules: Create and manage execution modules for dynamic task execution
  • Secure Data Handling: Field-level encryption through ThorAPI's SecureField
  • Comprehensive API Documentation: Automatically generated interactive API documentation
  • Type Safety: Fully-typed TypeScript clients for reliable and consistent API interactions
  • Database Connectivity: Easy connection to various relational databases via JPA
  • Professional Documentation: Automatically generated documentation site powered by Docusaurus

Getting Help​

If you need assistance with ValkyrAI, you can:

We're here to help you make the most of ValkyrAI!