# Akka SDK Documentation

> Akka is the agentic systems platform built for Reliability, Risk Control, and Repeatability
> at enterprise scale. The only full-stack platform for agentic AI: developer experience,
> runtime, and governance in one integrated system.

Three barriers stand between AI prototypes and production-grade agentic systems:
the Production Gap (frameworks built for demos cannot deliver production durability),
Liability (governance failures carry severe legal and financial consequences), and
the Specialist Trap (delivery depends on scarce distributed systems experts).

Akka solves these across three dimensions: Reliability (99.9999% availability, active-active
HA/DR, contractual commitments with indemnities), Risk Control (runtime-embedded governance,
policy enforcement, EU AI Act compliance), and Repeatability (golden-path workflows, SDD so
anyone who can write requirements can build).

Key differentiators: sub-10ms memory (vs ~200ms bolt-on), shared compute model cutting
infrastructure costs up to 90%, 18 years and 100,000+ production deployments, 19+ compliance
certifications including EU AI Act and ISO 42001.

Personas: Builders (Application Developers, AI/ML Engineers, Product Managers), Operators
(Platform Engineers, SREs), Governance & Oversight (Compliance Analysts, InfoSec, FinOps).

## About Akka

- [What is Akka?](https://doc.akka.io/what-is-akka.html.md): An agentic AI platform for enterprises — build, run, and govern production-grade agentic AI
- [Agents](https://doc.akka.io/akka-agents.html.md): Model-backed components with memory, tools, and multi-agent collaboration
- [Orchestration](https://doc.akka.io/akka-orchestration.html.md): Durable, multi-step coordination of agents and workflows
- [Memory](https://doc.akka.io/akka-memory.html.md): Durable, in-memory, sharded state for agents and entities
- [Streaming](https://doc.akka.io/akka-streaming.html.md): Real-time stream processing for event-driven and AI workloads
- [Automated Operations](https://doc.akka.io/akka-automated-operations.html.md): Run services with elastic scaling, resilience, and no-downtime updates
- [Akka Internals](https://doc.akka.io/akka-internals.html.md): How Akka works under the hood

## Getting Started

- [Getting started](https://doc.akka.io/getting-started/index.html.md): Install the Akka plugin, set up your environment, and run your first specification
- [Set up your dev env](https://doc.akka.io/getting-started/set-up-dev-env.html.md): Three self-contained setup paths — with an AI harness, without AI, or in a container
- [Spec-Driven Development](https://doc.akka.io/sdk/spec-driven-development.html.md): The primary development approach — describe requirements, Akka generates the system
- [Spec-first hello agent](https://doc.akka.io/getting-started/spec-your-first-agent.html.md): Build your first agent with spec-driven development
- [Code-first hello agent](https://doc.akka.io/getting-started/author-your-first-service.html.md): Build the same agent by hand in Java
- [Multi-agent tutorial](https://doc.akka.io/getting-started/planner-agent/index.html.md): Orchestrate multiple agents with a workflow
- [RAG chat tutorial](https://doc.akka.io/getting-started/ask-akka-agent/index.html.md): Build a retrieval-augmented chat agent
- [Shopping cart tutorial](https://doc.akka.io/getting-started/shopping-cart/index.html.md): Build an event-sourced service with entities and views

## SDK Components

- [Components overview](https://doc.akka.io/sdk/components/index.html.md): Introduction to Akka's core building blocks and their usage
- [Agents](https://doc.akka.io/sdk/agents.html.md): AI model-backed components with session memory and multi-agent collaboration
- [Autonomous Agents](https://doc.akka.io/sdk/autonomous-agents.html.md): Durable model-driven processes with typed tasks and multi-agent coordination
- [Workflows](https://doc.akka.io/sdk/workflows.html.md): Long-running, multi-step business processes with compensation
- [Event Sourced Entities](https://doc.akka.io/sdk/event-sourced-entities.html.md): State persistence via immutable event log
- [Key Value Entities](https://doc.akka.io/sdk/key-value-entities.html.md): State persistence via full-state snapshots
- [Views](https://doc.akka.io/sdk/views.html.md): Read-optimized projections across entities
- [HTTP Endpoints](https://doc.akka.io/sdk/http-endpoints.html.md): REST APIs with JSON, OpenAPI, server-sent events, and WebSocket support, plus serving web application assets
- [Web applications](https://doc.akka.io/sdk/web-applications.html.md): Serve a web application from a service — single-page application assets, static files, or generated HTML — alongside the API it calls, on your own domain with TLS
- [gRPC Endpoints](https://doc.akka.io/sdk/grpc-endpoints.html.md): High-performance APIs with gRPC
- [MCP Endpoints](https://doc.akka.io/sdk/mcp-endpoints.html.md): Expose services to MCP clients (A2A, ACP, MCP built into Agents)
- [Consumers](https://doc.akka.io/sdk/consuming-producing.html.md): Stream-based event consumption and production
- [Timed Actions](https://doc.akka.io/sdk/timed-actions.html.md): Scheduled and delayed calls

## Samples and blueprints

- [Samples and blueprints catalog](https://doc.akka.io/getting-started/samples.html.md): Browse runnable samples and generate systems from blueprints, filtered by AI use case, pattern, domain, components, and governance.

## Integrations

- [Integrations overview](https://doc.akka.io/sdk/integrations/index.html.md): Standard Java APIs, no proprietary adapters needed
- [Component and service calls](https://doc.akka.io/sdk/component-and-service-calls.html.md): Invoke other services and components directly
- [AI & models](https://doc.akka.io/sdk/integrations/ai-and-models.html.md): 9 built-in LLM providers plus custom provider support
- [Data & knowledge](https://doc.akka.io/sdk/integrations/data-and-knowledge.html.md): Vector DBs, relational, NoSQL, search engines. No caching layer needed.
- [Message broker integrations](https://doc.akka.io/sdk/integrations/messaging-and-events.html.md): Connecting Akka services with external message brokers
- [Messaging & events](https://doc.akka.io/sdk/integrations/messaging-and-events.html.md): Akka-native first, external brokers when needed
- [APIs & protocols](https://doc.akka.io/sdk/integrations/apis-and-protocols.html.md): REST, OpenAPI, WebSocket, gRPC, MCP, A2A, ACP, and browser-facing web application assets
- [Identity & security](https://doc.akka.io/sdk/integrations/identity-and-security.html.md): Native secrets, Azure KeyVault, standard Java APIs
- [Observability](https://doc.akka.io/sdk/integrations/observability.html.md): OpenTelemetry metrics and logs exporting
- [Streaming](https://doc.akka.io/sdk/streaming.html.md): Built-in stream processing and Akka Streams

## Concepts

- [AI Agents](https://doc.akka.io/concepts/ai-agents.html.md): Foundational concepts for building AI agents in Akka
- [Architecture model](https://doc.akka.io/concepts/architecture-model.html.md): How an Akka project is structured across api, application, and domain layers
- [Distributed systems](https://doc.akka.io/concepts/distributed-systems.html.md): Resilience, elasticity, and responsiveness
- [Multi-region operations](https://doc.akka.io/concepts/multi-region.html.md): Active-active HA/DR across regions
- [Declarative effects](https://doc.akka.io/concepts/declarative-effects.html.md): Composable, testable side effects
- [AI orchestration patterns](https://doc.akka.io/concepts/ai-orchestration-patterns.html.md): Patterns for composing and orchestrating agentic applications
- [State model](https://doc.akka.io/concepts/state-model.html.md): Understanding different entity state modeling approaches in Akka
- [Deployment model](https://doc.akka.io/concepts/deployment-model.html.md): Understanding how Akka services are packaged and deployed
- [Design considerations](https://doc.akka.io/sdk/dev-best-practices.html.md): Reactive principles, domain-driven design, service sizing, and deduplication

## Operating

- [Akka Automated Operations](https://doc.akka.io/operations/akka-platform.html.md): Managed platform for deploying and operating Akka services
- [Deploy a service](https://doc.akka.io/operations/services/deploy-service.html): Deploying to Akka
- [Observability](https://doc.akka.io/operations/observability-and-monitoring/index.html.md): Metrics, logs, traces, OTEL export
- [Secrets management](https://doc.akka.io/operations/projects/secrets.html.md): Built-in secrets with Azure KeyVault integration
- [CLI installation](https://doc.akka.io/operations/cli/installation.html.md): Install the Akka CLI
- [CI/CD integration](https://doc.akka.io/operations/integrating-cicd/index.html.md): GitHub Actions and other CI/CD tools

## Reference

- [Glossary](https://doc.akka.io/reference/glossary.html.md): Terms including AI, governance, and distributed systems terminology
- [Service configuration](https://doc.akka.io/reference/config/reference.html.md): Full HOCON configuration reference
- [CLI command reference](https://doc.akka.io/reference/cli/akka-cli/index.html): All Akka CLI commands
- [Release notes](https://doc.akka.io/reference/release-notes.html.md): Latest updates and changes
- [Model provider details](https://doc.akka.io/sdk/model-provider-details.html.md): Anthropic, OpenAI, Google, AWS Bedrock, Ollama, and more
- [Guardrails](https://doc.akka.io/sdk/agents/guardrails.html.md): Runtime policy enforcement
- [Data sanitization](https://doc.akka.io/sdk/sanitization.html.md): PII scrubbing with right to explain
- [Prompts](https://doc.akka.io/sdk/agents/prompt.html.md): Choosing the prompts for agents
- [Agent invocation](https://doc.akka.io/sdk/agents/calling.html.md): Calling agents from Akka code
- [Session memory](https://doc.akka.io/sdk/agents/memory.html.md): Managing agent session memory
- [Structured responses](https://doc.akka.io/sdk/agents/structured.html.md): Handling strongly typed responses from LLMs
- [Failure handling](https://doc.akka.io/sdk/agents/failures.html.md): Handling agent failures
- [Function tools](https://doc.akka.io/sdk/agents/extending.html.md): Extending agents with function (callback) tools
- [Streaming agent responses](https://doc.akka.io/sdk/agents/streaming.html.md): Streaming model responses with agents
- [Multi-agent orchestration](https://doc.akka.io/sdk/agents/orchestrating.html.md): Orchestrating and supervising multiple agents
- [Evaluating model responses](https://doc.akka.io/sdk/agents/llm_eval.html.md): Evaluating and judging the responses from LLMs via agents
- [Testing agents](https://doc.akka.io/sdk/agents/testing.html.md): Testing agents and agentic behavior
- [Agent definition](https://doc.akka.io/sdk/autonomous-agents/defining.html.md): Building an AgentDefinition with accepted task types, tools, guardrails, iteration limit, model, and optional instructions
- [Autonomous agent tasks](https://doc.akka.io/sdk/autonomous-agents/tasks.html.md): Task definitions, instances, lifecycle, snapshots, dependencies, and notifications
- [Autonomous agent coordination patterns](https://doc.akka.io/sdk/autonomous-agents/coordination.html.md): Sequential, delegative, collaborative, and emergent patterns for multi-agent systems
- [Autonomous agent coordination capabilities](https://doc.akka.io/sdk/autonomous-agents/capabilities.html.md): Delegation, handoff, teams, moderation, external input, and capability composition
- [Autonomous agent client API](https://doc.akka.io/sdk/autonomous-agents/client.html.md): runSingleTask, assignTasks, pause/resume, agent state, notification stream
- [Autonomous agent notifications](https://doc.akka.io/sdk/autonomous-agents/notifications.html.md): Lifecycle, task, handoff, delegation, team, conversation, messaging, and struggle notifications
- [Testing autonomous agents](https://doc.akka.io/sdk/autonomous-agents/testing.html.md): Mocking with TestModelProvider and AutonomousAgentTools helpers
- [Views](https://doc.akka.io/reference/views/index.html.md): Detailed reference for views
- [View Query Syntax](https://doc.akka.io/reference/views/syntax/query.html.md): View query language syntax
- [View Query Result Mapping](https://doc.akka.io/reference/views/concepts/result-mapping.html.md): How view query results are mapped into Java classes
- [Advanced Views](https://doc.akka.io/reference/views/concepts/advanced-views.html.md): Views for queries over tables populated from multiple different entities
- [Configuration](https://doc.akka.io/sdk/setup-and-configuration/index.html.md): Configuring and initializing Akka services
- [Setup and dependency injection](https://doc.akka.io/sdk/setup-and-dependency-injection.html.md): Integrating dependency injection with Akka services
- [Serialization](https://doc.akka.io/sdk/serialization.html.md): Configuring and customizing serialization for entity data and messages
- [Retrieval-Augmented Generation (RAG)](https://doc.akka.io/getting-started/ask-akka-agent/rag.html.md): Semantic search on vector databases to enrich AI model requests

## Optional

- [Run a service locally](https://doc.akka.io/sdk/running-locally.html.md): Steps to run and test Akka services in a local development environment
- [Run locally with a broker](https://doc.akka.io/sdk/running-with-broker.html.md): Run an Akka service locally against a Kafka broker or the Google Pub/Sub emulator
- [Run a local cluster](https://doc.akka.io/sdk/local-cluster.html.md): Run a multi-node Akka cluster locally
- [Using an AI coding assistant](https://doc.akka.io/sdk/ai-coding-assistant.html.md): Enable AI assistants to use the Akka CLI natively
- [Developing Access Control Lists (ACLs)](https://doc.akka.io/sdk/access-control.html.md): Implementing ACLs to control access to your Akka service endpoints
- [JSON Web Tokens (JWTs)](https://doc.akka.io/reference/jwts.html.md): Understanding JWT concepts and their role in Akka authentication
- [Developing JSON Web Tokens (JWT)](https://doc.akka.io/sdk/auth-with-jwts.html.md): Implementing JWT-based authentication in your Akka services
- [TLS certificates](https://doc.akka.io/operations/tls-certificates.html.md): Configuring and managing TLS certificates for secure communications
- [Operator best practices](https://doc.akka.io/operations/operator-best-practices.html.md): Recommendations for effectively operating Akka services in production
- [View logs](https://doc.akka.io/operations/observability-and-monitoring/view-logs.html.md): Accessing and analyzing logs from Akka services
- [View traces](https://doc.akka.io/operations/observability-and-monitoring/traces.html.md): Working with distributed tracing in Akka applications
- [View metrics](https://doc.akka.io/operations/observability-and-monitoring/metrics.html.md): Monitoring performance metrics for Akka services
- [Exporting metrics, logs, and traces](https://doc.akka.io/operations/observability-and-monitoring/observability-exports.html.md): Sending observability data to external monitoring systems
- [Using the Akka CLI](https://doc.akka.io/operations/cli/using-cli.html.md): Guide to the Akka Command Line Interface for managing services
- [Enable CLI command completion](https://doc.akka.io/operations/cli/command-completion.html.md): Setting up command completion for the Akka CLI
- [Configure message brokers](https://doc.akka.io/operations/projects/message-brokers.html.md): Setting up and configuring message brokers for Akka services
- [Using Aiven for Apache Kafka](https://doc.akka.io/operations/projects/broker-aiven.html.md): Integrating Aiven-hosted Kafka with Akka services
- [Using Confluent Cloud as Kafka service](https://doc.akka.io/operations/projects/broker-confluent.html.md): Setting up Confluent Cloud Kafka for use with Akka services
- [Using AWS MSK as Kafka service](https://doc.akka.io/operations/projects/broker-aws-msk.html.md): Configuring AWS Managed Streaming for Kafka with Akka services
- [Using a self-hosted or arbitrary Kafka cluster](https://doc.akka.io/operations/projects/broker-kafka.html.md): Connecting Akka to any Kafka cluster that meets the supported authentication and TLS requirements
- [Using Google Cloud Pub/Sub as message broker](https://doc.akka.io/operations/projects/broker-google-pubsub.html.md): Integrating Google Cloud Pub/Sub with Akka services
- [Projects](https://doc.akka.io/operations/projects/index.html.md): Managing projects in the Akka Platform
- [Create a new project](https://doc.akka.io/operations/projects/create-project.html.md): Steps to create and configure a new project in the Akka Platform
- [Managing project users](https://doc.akka.io/operations/projects/manage-project-access.html.md): Controlling user access to projects in the Akka Platform
- [Configure a container registry](https://doc.akka.io/operations/projects/container-registries.html.md): Setting up and managing container registries for Akka deployments
- [Configure an external container registry](https://doc.akka.io/operations/projects/external-container-registries.html.md): Setting up external container registries for Akka service deployments
- [Organizations](https://doc.akka.io/operations/organizations/index.html.md): Working with organizations in the Akka Platform
- [Managing organization users](https://doc.akka.io/operations/organizations/manage-users.html.md): Adding, removing, and managing user access within your organization
- [Regions](https://doc.akka.io/operations/organizations/regions.html.md): Understanding geographical regions for Akka Platform deployments
- [Operating - Akka Automated Operations (AAO)](https://doc.akka.io/operations/akka-platform.html.md): Automatically manages, monitors, and gathers insights from your deployed services and managed infrastructure.
- [Operating - Self-managed nodes](https://doc.akka.io/operations/index.html.md): Guide to running Akka on self-managed infrastructure
- [Resources](https://doc.akka.io/resources.html.md): Blogs, demos, webinars, foundational works, training, and community
- [Reactive Manifesto](https://www.reactivemanifesto.org): Foundational philosophy behind Akka
- [Reactive Principles](https://www.reactiveprinciples.org): Cloud-native and edge-native design principles
- [Blog](https://akka.io/blog): Technical articles and product updates
- [Corporate context (akka.io/llms.txt)](https://akka.io/llms.txt): Business, pricing, partnerships, and go-to-market

### Examples

- [helloworld-agent](https://raw.githubusercontent.com/akka-samples/helloworld-agent/refs/heads/main/README.md): Agent with LLM greetings and session memory
- [multi-agent](https://raw.githubusercontent.com/akka-samples/multi-agent/refs/heads/main/README.md): Multi-agent system with an Autonomous Agent coordinator delegating to worker agents
- [autonomous-agent-playground](https://raw.githubusercontent.com/akka-samples/autonomous-agent-playground/refs/heads/main/README.md): Autonomous agents with LLM driven multi-agent orchestration
- [ask-akka-agent](https://raw.githubusercontent.com/akka-samples/ask-akka-agent/refs/heads/main/README.md): RAG agent with vector search and streaming
- [travel-agent](https://raw.githubusercontent.com/akka-samples/travel-agent/refs/heads/main/README.md): AI travel planner with durable state
- [temperature-monitoring-agent](https://raw.githubusercontent.com/akka-samples/temperature-monitoring-agent/refs/heads/main/README.md): IoT sensor monitoring with AI analysis
- [medical-tagging-agent](https://raw.githubusercontent.com/akka-samples/medical-tagging-agent/refs/heads/main/README.md): Medical discharge tagging with human verification
- [changelog-agent](https://raw.githubusercontent.com/akka-samples/changelog-agent/refs/heads/main/README.md): Automated release note summarization
- [real-estate-cs-agent](https://raw.githubusercontent.com/akka-samples/real-estate-cs-agent/refs/heads/main/README.md): Customer service agentic workflow
- [trip-agent](https://raw.githubusercontent.com/akka-samples/trip-agent/refs/heads/main/README.md): Travel booking with Anthropic and Spring AI
- [agentic-haiku](https://raw.githubusercontent.com/akka-samples/agentic-haiku/refs/heads/main/README.md): Workflow orchestration for creative generation
- [healthcare-agent](https://raw.githubusercontent.com/akka-samples/healthcare-agent/refs/heads/main/README.md): Health data analysis with Fitbit and MongoDB
- [shopping-cart](https://raw.githubusercontent.com/akka-samples/shopping-cart-quickstart/refs/heads/main/README.md): Event-sourced shopping cart
- [customer-registry](https://raw.githubusercontent.com/akka-samples/event-sourced-customer-registry/refs/heads/main/README.md): Customer registry with queries
- [transfer-workflow](https://raw.githubusercontent.com/akka-samples/transfer-workflow-compensation/refs/heads/main/README.md): Funds transfer with compensation
- [choreography-saga](https://raw.githubusercontent.com/akka-samples/choreography-saga-quickstart/refs/heads/main/README.md): User registration choreography saga
- [akka-chess](https://raw.githubusercontent.com/akka-samples/akka-chess/refs/heads/main/README.md): Complete event-sourced chess application