Skip to content

installation.md

Latest commit

 

History

History
67 lines (44 loc) · 1.93 KB

installation.md

File metadata and controls

67 lines (44 loc) · 1.93 KB
sidebar_position 1
title Installation
description Install the Agora Conversational AI Python SDK.

Installation

Prerequisites

  • Python >= 3.8

Install with pip

pip install agora-agents

Install with Poetry

poetry add agora-agents

Imports

from agora_agent import Agent, Agora, Area, DeepgramSTT, OpenAI

The package installs as agora-agents and imports as agora_agent.

Sync vs. Async

The SDK supports both synchronous and asynchronous usage:

  • Synchronous — import Agora from agora_agent and use blocking method calls
  • Asynchronous — import AsyncAgora and AsyncAgentSession from agora_agent and use await with all API calls
# Sync
from agora_agent import Agora, Area

# Async
from agora_agent import AsyncAgora, AsyncAgentSession, Area

Dependencies

Package Purpose
httpx (>= 0.21.2) HTTP client for sync and async requests
pydantic (>= 1.9.2) Data validation for vendor configuration and API types
typing_extensions (>= 4.0.0) Backported type hints for Python 3.8+

Next steps

Migrating from a previous package name

The PyPI distribution was renamed from agora-agent-server-sdk to agora-agents in v2.0.0. Install agora-agents; the import path remains agora_agent.

The legacy PyPI name remains available as a compatibility shim that re-exports agora-agents. See compat/agora-agent-server-sdk.

For release and version details, see changelog — Migration notes.