You're reading the SDK docs · Switch to Libraries
 
Contact Us Sign In Get Started
 

Akka

    • About Akka
      • What is Akka?
      • Agents
      • Orchestration
      • Memory
      • Streaming
      • Automated Operations
      • Akka Internals
    • Getting Started
      • Set up your dev env
      • Spec-first hello agent
      • Code-first hello agent
      • Multi-agent tutorial
        • Activity agent
        • User preferences
        • Weather agent
        • Orchestrate the agents
        • Dynamic orchestration
        • Evaluating task results
      • RAG chat tutorial
        • Creating the agent
        • Knowledge indexing with a workflow
        • Executing RAG queries
        • Adding UI endpoints
      • Shopping cart tutorial
        • A simple shopping cart service
        • Authenticated user-specific lookup
      • Samples and blueprints
    • Understanding
      • Concepts
      • Foundations
        • Distributed systems
        • Architecture model
        • Deployment model
      • State and execution
        • State model
        • Declarative effects
        • Multi-region operations
      • Agentic concepts
        • AI agents
        • AI orchestration patterns
      • Resources
    • Developing
      • Building with AI
        • Spec-driven development
        • Using an AI coding assistant
      • Components
        • Agents
          • Choosing the prompt
          • Calling agents
          • Managing session memory
          • Structured responses
          • Handling failures
          • Extending with function tools
          • Streaming responses
          • Orchestrating multiple agents
          • Guardrails
          • LLM evaluation
          • Testing
        • Autonomous Agents
          • Defining an autonomous agent
          • Tasks
          • Coordination patterns
          • Coordination capabilities
          • Client API
          • Notifications
          • Testing
        • Event Sourced Entities
        • Key Value Entities
        • HTTP Endpoints
        • gRPC Endpoints
        • MCP Endpoints
        • Views
        • Workflows
        • Timers
        • Consumers
      • Integrations
        • Component and service calls
        • AI & models
        • Data & knowledge
        • Object storage
        • Messaging & events
        • APIs & protocols
        • Identity & security
        • Observability
        • Streaming
      • Configuration
        • Setup and dependency injection
        • Serialization
        • Errors and failures
        • Access Control Lists (ACLs)
        • JSON Web Tokens (JWT)
        • AI model provider configuration
        • Data sanitization
        • Metrics
        • Run a service locally
        • Run locally with a broker
        • Run a local cluster
      • Design considerations
    • Operating
      • Self-managed operations
      • Akka Automated Operations
        • Organizations
          • Manage users
          • Regions
        • 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
            • Self-hosted Kafka
            • Azure Event Hubs
          • Manage secrets
          • Manage external secrets
        • Services
          • Deploy and manage services
          • Service configuration overrides
          • Invoking Akka services
          • Viewing data
          • Data migration
          • Configuring a custom JVM truststore
          • Workload Identity
        • Regions
          • Multi-region setup
          • Multi-region infrastructure
        • TLS certificates
        • Observability and monitoring
          • View logs
          • View metrics
          • View traces
          • Exporting metrics, logs, and traces
          • Alerting baselines
        • Integrating with CI/CD tools
          • CI/CD with GitHub Actions
        • CLI
          • Install the Akka CLI
          • Using the Akka CLI
          • Enable CLI command completion
          • System Configuration
      • Operator best practices
    • Reference
      • Glossary of terms
      • API documentation
      • Descriptors
        • Project descriptor
        • Service descriptor
        • Route descriptor
        • External secret descriptor
        • Observability descriptor
      • Service configuration
      • CLI commands
        • 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 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 check
        • akka code context-update
        • akka code init
        • akka code token
        • 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 cluster
        • 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 workflows get
        • akka local services components list-events
        • akka local services components list-ids
        • akka local services components list-interactions
        • 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 get-state
        • akka local services views list
        • akka local services views query
        • akka local services views
        • akka local services
        • akka local start
        • akka local status
        • akka local stop
        • akka local
        • akka logs
        • akka mcp serve
        • akka mcp
        • akka organizations auth add openid
        • akka organizations auth add
        • akka organizations auth list
        • akka organizations auth remove
        • akka organizations auth show
        • akka organizations auth test
        • 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 apply
        • 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 export
        • 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 add default azure-monitor
        • akka projects observability add default google-cloud
        • akka projects observability add default otlp-http
        • akka projects observability add default otlp
        • akka projects observability add default splunk-hec
        • akka projects observability add default
        • akka projects observability add logs azure-monitor
        • akka projects observability add logs google-cloud
        • akka projects observability add logs otlp-http
        • akka projects observability add logs otlp
        • akka projects observability add logs splunk-hec
        • akka projects observability add logs
        • akka projects observability add metrics azure-monitor
        • akka projects observability add metrics google-cloud
        • akka projects observability add metrics otlp-http
        • akka projects observability add metrics otlp
        • akka projects observability add metrics prometheus
        • akka projects observability add metrics splunk-hec
        • akka projects observability add metrics
        • akka projects observability add traces azure-monitor
        • akka projects observability add traces google-cloud
        • akka projects observability add traces otlp-http
        • akka projects observability add traces otlp
        • akka projects observability add traces
        • akka projects observability add
        • 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 remove default azure-monitor
        • akka projects observability remove default google-cloud
        • akka projects observability remove default otlp-http
        • akka projects observability remove default otlp
        • akka projects observability remove default splunk-hec
        • akka projects observability remove default
        • akka projects observability remove logs azure-monitor
        • akka projects observability remove logs google-cloud
        • akka projects observability remove logs otlp-http
        • akka projects observability remove logs otlp
        • akka projects observability remove logs splunk-hec
        • akka projects observability remove logs
        • akka projects observability remove metrics azure-monitor
        • akka projects observability remove metrics google-cloud
        • akka projects observability remove metrics otlp-http
        • akka projects observability remove metrics otlp
        • akka projects observability remove metrics prometheus
        • akka projects observability remove metrics splunk-hec
        • akka projects observability remove metrics
        • akka projects observability remove traces azure-monitor
        • akka projects observability remove traces google-cloud
        • akka projects observability remove traces otlp-http
        • akka projects observability remove traces otlp
        • akka projects observability remove traces
        • akka projects observability remove
        • akka projects observability set default akka-console
        • akka projects observability set default azure-monitor
        • 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 azure-monitor
        • 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 azure-monitor
        • 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 azure-monitor
        • 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 bring-up-region
        • 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 external create aws
        • akka secrets external create azure
        • akka secrets external create gcp
        • akka secrets external create
        • akka secrets external delete
        • akka secrets external get
        • akka secrets external info
        • akka secrets external list
        • akka secrets external update aws
        • akka secrets external update azure
        • akka secrets external update gcp
        • akka secrets external update
        • akka secrets external
        • akka secrets get
        • akka secrets list
        • akka secrets
        • akka service-configs create
        • akka service-configs delete
        • akka service-configs get
        • akka service-configs list
        • akka service-configs
        • akka services apply
        • akka services components get-state
        • akka services components workflows get
        • akka services components list-events
        • akka services components list-ids
        • akka services components list-interactions
        • 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 remove-config
        • akka services restart
        • akka services restore
        • akka services resume
        • akka services set-config
        • akka services unexpose
        • akka services views describe
        • akka services views drop
        • akka services views get-state
        • akka services views list
        • akka services views query
        • akka services views
        • akka services
        • akka specify init
        • akka specify
        • akka version
        • akka
      • Specify commands
        • /akka.analyze
        • /akka.build
        • /akka.checklist
        • /akka.clarify
        • /akka.constitution
        • /akka.deploy
        • /akka.implement
        • /akka.inspect
        • /akka.issues
        • /akka.plan
        • /akka.review
        • /akka.setup
        • /akka.specify
        • /akka.tasks
      • Views
        • View query syntax
          • Query
          • SELECT
          • FROM
          • WHERE
          • AS
          • LIMIT
          • OFFSET
          • ORDER BY
          • GROUP BY
          • JOIN
          • Operators
            • Comparison operators
            • Logical operators
            • IN
            • = ANY
            • LIKE
            • IS NULL/IS NOT NULL
          • Functions
            • collect()
            • count()
            • DISTINCT
            • text_search()
            • total_count()
            • has_more()
            • next_page_token()
            • page_token_offset()
        • View concepts
          • Table updaters
          • Data types
          • Result mapping
          • Optional fields
          • Array types
          • Pagination
          • Advanced views
      • Telemetry
        • Metrics reference
        • (Deprecated) Prometheus metrics reference
        • Tracing reference
      • JSON Web Tokens (JWTs)
      • OpenID connect
      • Migration guide
      • Release notes
      • Security announcements
      • Support resources
    • Akka Libraries
Akka default
  • Akka
  • Akka
  • Reference

Reference

Technical reference material for various aspects of Akka.

Topics

  • Akka Libraries

  • Views

  • Service Descriptor reference

  • Route Descriptor reference

  • Observability Descriptor reference

  • Service configuration

  • Release notes

  • Glossary of terms

  • API documentation

  • CLI commands

Operator best practices Glossary of terms

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