IMPORTANT: We changed our binary download resolvers. Update your config file now.

Developers

Docs

SDK Libraries

Resources

Ask AI Blog Release Notes Support

Architecture

Principles Free Training Certification
SDK

SDK

Key Value Entities Event Sourced Entities Views

 

Timers Workflows
 
Contact Us Sign In Get Started
 

Akka

    • Tutorials
      • Hello world agent
      • Multi-agent planner
        • Activity agent
        • User preferences
        • Weather agent
        • Orchestrate the agents
        • List by user
        • Dynamic orchestration
        • Evaluation on changes
      • RAG chat agent
        • Creating the agent
        • Knowledge indexing with a workflow
        • Executing RAG queries
        • Adding UI endpoints
      • Shopping cart
        • A simple shopping cart service
        • Authenticated user-specific lookup
      • Additional samples
    • Understanding
      • Concepts
      • Distributed systems
      • Project structure
      • Deployment model
      • Development process
      • Delegation with Effects
      • Entity state models
      • Multi-region operations
      • Saga patterns
      • Endpoints
      • Building AI agents
      • Inter-agent communications
      • Access Control List concepts
    • Developing
      • Components
        • Agents
        • Event Sourced Entities
        • Key Value Entities
        • HTTP Endpoints
        • gRPC Endpoints
        • MCP Endpoints
        • Views
        • Workflows
        • Timers
        • Consumers
      • Integrations
        • Component and service calls
        • Message broker integrations
        • Streaming
        • Retrieval-Augmented Generation (RAG)
      • Setup and configuration
        • Setup and dependency injection
        • Serialization
        • Errors and failures
        • Access Control Lists (ACLs)
        • JSON Web Tokens (JWT)
        • Run a service locally
        • AI model provider configuration
      • Developer best practices
      • Using an AI coding assistant
    • Operating
      • Self-managed operations
      • Akka Automated Operations
        • Organizations
          • Manage users
          • Regions
          • Billing
        • Projects
          • Create
          • Manage users
          • Configure a container registry
            • Configure an external container registry
          • Configure message brokers
            • Google Pub/Sub
            • Confluent Cloud
            • AWS MSK Kafka
            • Aiven for Kafka
          • Manage secrets
        • Services
          • Deploy and manage services
          • Invoking Akka services
          • Viewing data
          • Data migration
        • Regions
        • TLS certificates
        • Observability and monitoring
          • View logs
          • View metrics
          • View traces
          • Exporting metrics, logs, and traces
        • Integrating with CI/CD tools
          • CI/CD with GitHub Actions
        • CLI
          • Install the Akka CLI
          • Using the Akka CLI
          • Enable CLI command completion
      • Akka Automated Operations features
      • Operator best practices
    • Reference
      • Service descriptor
      • Route descriptor
      • Observability descriptor
      • Glossary of terms
      • Security announcements
      • Release notes
      • Migration guide
      • API documentation
      • View query language
      • JSON Web Tokens (JWTs)
      • CLI command reference
        • akka
        • akka auth
        • akka auth container-registry
        • akka auth container-registry clear-cached-token
        • akka auth container-registry configure
        • akka auth container-registry credentials
        • akka auth container-registry install-helper
        • akka auth container-registry
        • akka auth current-login
        • akka auth login
        • akka auth logout
        • akka auth signup
        • akka auth tokens create
        • akka auth tokens list
        • akka auth tokens revoke
        • akka auth tokens
        • akka auth use-token
        • akka auth
        • akka code init
        • akka code
        • akka completion
        • akka config clear-cache
        • akka config clear
        • akka config current-context
        • akka config delete-context
        • akka config get-organization
        • akka config get-project
        • akka config get
        • akka config list-contexts
        • akka config list
        • akka config rename-context
        • akka config set
        • akka config use-context
        • akka config
        • akka container-registry delete-image
        • akka container-registry list-images
        • akka container-registry list-tags
        • akka container-registry list
        • akka container-registry print
        • akka container-registry push
        • akka container-registry
        • akka docker add-credentials
        • akka docker list-credentials
        • akka docker remove-credentials
        • akka docker
        • akka docs
        • akka local console
        • akka local remote add
        • akka local remote list
        • akka local remote remove
        • akka local remote
        • akka local services components get-state
        • akka local services components get-workflow
        • akka local services components list-events
        • akka local services components list-ids
        • akka local services components list-timers
        • akka local services components list
        • akka local services components
        • akka local services connectivity
        • akka local services list
        • akka local services views describe
        • akka local services views drop
        • akka local services views list
        • akka local services views
        • akka local services
        • akka local
        • akka logs
        • akka organizations auth add openid
        • akka organizations auth add
        • akka organizations auth list
        • akka organizations auth remove
        • akka organizations auth show
        • akka organizations auth update openid
        • akka organizations auth update
        • akka organizations auth
        • akka organizations get
        • akka organizations invitations cancel
        • akka organizations invitations create
        • akka organizations invitations list
        • akka organizations invitations
        • akka organizations list
        • akka organizations users add-binding
        • akka organizations users delete-binding
        • akka organizations users list-bindings
        • akka organizations users
        • akka organizations
        • akka projects config get broker
        • akka projects config get
        • akka projects config set broker
        • akka projects config set
        • akka projects config unset broker
        • akka projects config unset
        • akka projects config
        • akka projects delete
        • akka projects get
        • akka projects hostnames add
        • akka projects hostnames list
        • akka projects hostnames remove
        • akka projects hostnames update
        • akka projects hostnames
        • akka projects list
        • akka projects new
        • akka projects observability apply
        • akka projects observability config traces
        • akka projects observability config
        • akka projects observability edit
        • akka projects observability export
        • akka projects observability get
        • akka projects observability set default akka-console
        • akka projects observability set default google-cloud
        • akka projects observability set default otlp-http
        • akka projects observability set default otlp
        • akka projects observability set default splunk-hec
        • akka projects observability set default
        • akka projects observability set logs google-cloud
        • akka projects observability set logs otlp-http
        • akka projects observability set logs otlp
        • akka projects observability set logs splunk-hec
        • akka projects observability set logs
        • akka projects observability set metrics google-cloud
        • akka projects observability set metrics otlp-http
        • akka projects observability set metrics otlp
        • akka projects observability set metrics prometheus
        • akka projects observability set metrics splunk-hec
        • akka projects observability set metrics
        • akka projects observability set traces google-cloud
        • akka projects observability set traces otlp-http
        • akka projects observability set traces otlp
        • akka projects observability set traces
        • akka projects observability set
        • akka projects observability unset default
        • akka projects observability unset logs
        • akka projects observability unset metrics
        • akka projects observability unset traces
        • akka projects observability unset
        • akka projects observability
        • akka projects open
        • akka projects regions add
        • akka projects regions list
        • akka projects regions remove
        • akka projects regions set-primary
        • akka projects regions
        • akka projects settings down-region
        • akka projects settings
        • akka projects tokens create
        • akka projects tokens list
        • akka projects tokens revoke
        • akka projects tokens
        • akka projects update
        • akka projects
        • akka regions list
        • akka regions
        • akka roles add-binding
        • akka roles delete-binding
        • akka roles invitations delete
        • akka roles invitations invite-user
        • akka roles invitations list
        • akka roles invitations
        • akka roles list-bindings
        • akka roles list
        • akka roles
        • akka routes create
        • akka routes delete
        • akka routes edit
        • akka routes export
        • akka routes get
        • akka routes list
        • akka routes update
        • akka routes
        • akka secrets create asymmetric
        • akka secrets create generic
        • akka secrets create symmetric
        • akka secrets create tls-ca
        • akka secrets create tls
        • akka secrets create
        • akka secrets delete
        • akka secrets get
        • akka secrets list
        • akka secrets
        • akka services apply
        • akka services components get-state
        • akka services components get-workflow
        • akka services components list-events
        • akka services components list-ids
        • akka services components list-timers
        • akka services components list
        • akka services components
        • akka services connectivity
        • akka services data cancel-task
        • akka services data export
        • akka services data get-task
        • akka services data import
        • akka services data list-tasks
        • akka services data watch-task
        • akka services data
        • akka services delete
        • akka services deploy
        • akka services edit
        • akka services export
        • akka services expose
        • akka services get
        • akka services jwts add
        • akka services jwts generate
        • akka services jwts list-algorithms
        • akka services jwts list
        • akka services jwts remove
        • akka services jwts update
        • akka services jwts
        • akka services list
        • akka services logging list
        • akka services logging set-level
        • akka services logging unset-level
        • akka services logging
        • akka services pause
        • akka services proxy
        • akka services restart
        • akka services restore
        • akka services resume
        • akka services unexpose
        • akka services views describe
        • akka services views drop
        • akka services views list
        • akka services views
        • akka services
        • akka version
        • akka
    • Akka Libraries
Akka default
  • Akka
  • Akka
  • Reference
  • API documentation

API documentation

The API documentation of the Akka SDK is available for both the SDK and its testkit:

  • Akka SDK - Javadoc API documentation

  • Akka SDK testkit - Javadoc API documentation

Migration guide View query language

© 2011 - , Lightbend, Inc. All rights reserved. | Licenses | Terms | Privacy Policy | Cookie Listing | Cookie Settings | RSS