Skip to main content

Integration library for Microsoft Agents with aiohttp

Project description

Microsoft Agents Hosting - aiohttp

PyPI version

Integration library for hosting Microsoft 365 Agents using aiohttp. This library provides HTTP adapters, middleware, and utilities for building web-based agent applications with the popular aiohttp framework.

This library bridges the Microsoft 365 Agents SDK with aiohttp, allowing you to create HTTP endpoints that handle agent conversations. It provides everything you need to host agents as web services, including request processing, authentication, and routing.

What is this?

This library is part of the Microsoft 365 Agents SDK for Python - a comprehensive framework for building enterprise-grade conversational AI agents. The SDK enables developers to create intelligent agents that work across multiple platforms including Microsoft Teams, M365 Copilot, Copilot Studio, and web chat, with support for third-party integrations like Slack, Facebook Messenger, and Twilio.

Release Notes

Version Date Release Notes
0.8.0 2026-02-23 0.8.0 Release Notes
0.7.0 2026-01-21 0.7.0 Release Notes
0.6.1 2025-12-01 0.6.1 Release Notes
0.6.0 2025-11-18 0.6.0 Release Notes
0.5.0 2025-10-22 0.5.0 Release Notes

Packages Overview

We offer the following PyPI packages to create conversational experiences based on Agents:

Package Name PyPI Version Description
microsoft-agents-activity PyPI Types and validators implementing the Activity protocol spec.
microsoft-agents-hosting-core PyPI Core library for Microsoft Agents hosting.
microsoft-agents-hosting-aiohttp PyPI Configures aiohttp to run the Agent.
microsoft-agents-hosting-teams PyPI Provides classes to host an Agent for Teams.
microsoft-agents-storage-blob PyPI Extension to use Azure Blob as storage.
microsoft-agents-storage-cosmos PyPI Extension to use CosmosDB as storage.
microsoft-agents-authentication-msal PyPI MSAL-based authentication for Microsoft Agents.

Additionally we provide a Copilot Studio Client, to interact with Agents created in CopilotStudio:

Package Name PyPI Version Description
microsoft-agents-copilotstudio-client PyPI Direct to Engine client to interact with Agents created in CopilotStudio

Installation

pip install microsoft-agents-hosting-aiohttp

Simple Echo Agent

See the Quickstart sample for full working code.

agents_sdk_config = load_configuration_from_env(environ)

STORAGE = MemoryStorage()
CONNECTION_MANAGER = MsalConnectionManager(**agents_sdk_config)
ADAPTER = CloudAdapter(connection_manager=CONNECTION_MANAGER)
AUTHORIZATION = Authorization(STORAGE, CONNECTION_MANAGER, **agents_sdk_config)

AGENT_APP = AgentApplication[TurnState](
    storage=STORAGE, adapter=ADAPTER, authorization=AUTHORIZATION, **agents_sdk_config
)

@AGENT_APP.activity("message")
async def on_message(context: TurnContext, state: TurnState):
    await context.send_activity(f"You said: {context.activity.text}")

...

start_server(
    agent_application=AGENT_APP,
    auth_configuration=CONNECTION_MANAGER.get_default_connection_configuration(),
)

Error Handling

Customize error responses. Code take from the Quickstart sample.

@AGENT_APP.error
async def on_error(context: TurnContext, error: Exception):
    # This check writes out errors to console log
    # NOTE: In production environment, you should consider logging this to Azure
    #       application insights.
    print(f"\n [on_turn_error] unhandled error: {error}", file=sys.stderr)
    traceback.print_exc()

    # Send a message to the user
    await context.send_activity("The bot encountered an error or bug.")

Features

HTTP hosting - Full aiohttp integration for web hosting
JWT authentication - Built-in security with middleware
Agent-to-agent - Support for multi-agent communication
Streaming - Real-time response streaming
Error handling - Comprehensive error management
Development friendly - Hot reload and debugging support

Requirements

  • Python 3.10+ (supports 3.10, 3.11, 3.12, 3.13, 3.14)
  • aiohttp 3.11.11+
  • Microsoft Agents hosting core library

Best Practices

  1. Use middleware for cross-cutting concerns like auth and logging
  2. Handle errors gracefully with custom error handlers
  3. Secure your endpoints with JWT middleware in production
  4. Structure routes logically for agent communication

Quick Links

Sample Applications

Name Description README
Quickstart Simplest agent Quickstart
Auto Sign In Simple OAuth agent using Graph and GitHub auto-signin
OBO Authorization OBO flow to access a Copilot Studio Agent obo-authorization
Semantic Kernel Integration A weather agent built with Semantic Kernel semantic-kernel-multiturn
Streaming Agent Streams OpenAI responses azure-ai-streaming
Copilot Studio Client Console app to consume a Copilot Studio Agent copilotstudio-client
Cards Agent Agent that uses rich cards to enhance conversation design cards

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file microsoft_agents_hosting_aiohttp-0.9.0.dev8.tar.gz.

File metadata

File hashes

Hashes for microsoft_agents_hosting_aiohttp-0.9.0.dev8.tar.gz
Algorithm Hash digest
SHA256 4b8c0e2d8d91611a85f0223d42d449e7bf61306b326f3bb30fad94b9e21523c0
MD5 14c373cc7cec07d5a8edf174c7828e59
BLAKE2b-256 2b767feddeb9a5da6923eb6e822ed9000e803c6e1e6671f708444f8342f5b979

See more details on using hashes here.

File details

Details for the file microsoft_agents_hosting_aiohttp-0.9.0.dev8-py3-none-any.whl.

File metadata

File hashes

Hashes for microsoft_agents_hosting_aiohttp-0.9.0.dev8-py3-none-any.whl
Algorithm Hash digest
SHA256 b8cbf5be3288228bf6a6705680b7f7c07ee8f4080ba7c67bec78495bc418c297
MD5 400f3535f3889ace1995ec65f9eec124
BLAKE2b-256 da41e2b37207f3d4f0782a26dcffea7e47799ec8f24aa7dc8f597ab4dea6aace

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page