Skip to main content

ValkyrAI Documentation

ValkyrAI (currently v0.6.0 BETA) is Valkyr Labs’ API-native agentic services engine. The platform fuses ThorAPI’s secure code generation with Spring Boot 3.4 services, workflow automation, and Model Context Protocol tooling to deliver production-ready backends and orchestration for ValorIDE and enterprise apps.

What Is ValkyrAI?​

At its core, ValkyrAI ingests OpenAPI specifications (or higher-level process definitions) and produces coordinated Java services, TypeScript clients, RBAC policies, and workflow modules. It layers in SecureField encryption, audit trails, and task orchestration so teams can deploy usable systems immediately instead of stitching scaffolding by hand.

Repository Modules (pom.xml)​

  • thorapi/ – foundational generators, shared data models, and encryption utilities that power the wider Valhalla suite.
  • web/ – Docusaurus and TypeScript assets that publish docs, dashboards, and the Valkyr Labs website content.
  • valkyrai/ – primary Spring Boot service hosting workflow APIs, MCP endpoints, AWS integrations, and WebSocket channels.
  • gridheim/ – dashboards and React experiences (Gridheim) for monitoring thor/valkyr deployments.

Maven orchestrates these modules from the root valhalla parent (Java 17, spring-boot-starter-parent 3.4.6) so a single build can compile generators, services, and UI artefacts.

Key Features (2025 refresh)​

  • Agentic workflow runtime – create, schedule, and monitor workflows/tasks/execution modules via REST or ValorIDE-driven commands.
  • ThorAPI code generation – transform OpenAPI specs into secured Spring Boot services and typed React/TypeScript clients with minimal configuration.
  • SecureField & KMS – built-in field-level encryption, key rotation, and helpers for running jobs under system accounts.
  • Model Context Protocol – expose ValkyrAI automation as MCP tools so ValorIDE (and other agents) can delegate work safely.
  • Observability & dashboards – Gridheim UI, Valhalla Ops Center dashboards, and enhanced 6D reporting keep track of costs, tokens, and job health.
  • Cloud connectors – AWS Bedrock/Vertex/Gemini credentials, STS role helpers, and workflow step integrations for enterprise environments.
  • Documentation toolchain – Docusaurus-powered docs (this site), API docs via SpringDoc, and publishable marketing pages under web/typescript/.

Documentation Map​

  • Overview – product positioning, architecture diagrams, and high-level capabilities.
  • Getting Started – environment setup (Java 17, Maven, Node), project generation, and local run instructions.
  • Developers Guide – deep dives into modules, security, and operational recipes.
  • Workflow Engine – design of the BPM/agentic runtime.
  • SecureFieldKMS – encryption patterns and key custody recommendations.
  • Model Context Protocol – MCP server implementation details used by ValorIDE.
  • Utilities – helper CLIs, importers, and admin tasks.

ValkyrAI & ValorIDE​

ValorIDE uses ValkyrAI as its default backend for long-running tasks, ThorAPI codegen, and organization-level approvals. Many extension features (project scaffolding, billing dashboards, workflow orchestration) call the APIs exposed by the valkyrai module or read artifacts generated in thorapi/.

Getting Help​

We’re continuously expanding ValkyrAI—watch the Maven build badge in the README for the latest pipeline status and release cadence.