Skip to content

index.md

Latest commit

 

History

History
60 lines (47 loc) · 3.46 KB

index.md

File metadata and controls

60 lines (47 loc) · 3.46 KB
Raw
sidebar_position 1
title Overview
description The Agora Conversational AI Python SDK — install, concepts, and examples.

Agora Conversational AI Python SDK

The Agora Conversational AI Python SDK lets you build voice-powered AI agents on the Agora Conversational AI platform.

Client models

  • Agora for synchronous applications
  • AsyncAgora for asyncio applications

Conversation flows

Cascading flow uses ASR -> LLM -> TTS and supports the broadest set of vendor combinations.

MLLM flow uses a multimodal model such as OpenAI Realtime, Azure OpenAI Realtime, Gemini Live, Vertex AI, xAI Grok, or Qwen Omni for end-to-end audio.

Start here

  • Start with Quick Start. It shows the baseline app-credentials setup and starts a cascading ASR -> LLM -> TTS agent.
  • Use MLLM Flow when your agent uses one supported realtime multimodal model.
  • Use Cascading Flow for more examples of the default ASR -> LLM -> TTS flow, including provider-specific configuration.

How the SDK is organized

Layer What it does When to use
AgentKit (Agent, AgentSession, vendor classes) High-level builder pattern, lifecycle, typed vendors Most use cases
Generated REST clients (client.agents, client.telephony) Typed access to REST APIs not covered by AgentKit Advanced use cases

Documentation

Section What you will learn
Installation Install the SDK and prerequisites
Authentication App credentials and other auth modes
Quick Start App credentials and AgentKit
Agent Builder Features Turn detection, SAL, filler words, and advanced agent options
BYOK Bring your own vendor credentials and config
Architecture SDK structure and generated REST clients
Agent Configure agents with the fluent builder
AgentSession Manage the agent lifecycle
Vendors Browse all LLM, TTS, STT, MLLM, and Avatar providers
Cascading Flow Build an ASR -> LLM -> TTS pipeline
MLLM Flow Use a global or CN realtime multimodal model for end-to-end audio
Avatars Add a digital avatar with LiveAvatar, Akool, Anam, Generic Avatar, SenseTime, or Spatius
Regional Routing Route requests to the nearest region
Error Handling Handle API errors with ApiError
Pagination Iterate over paginated list endpoints
Advanced Raw response, retries, timeouts, custom httpx client
Low-Level API Generated REST APIs
Client Reference Full Agora / AsyncAgora API
Agent Reference Full Agent builder API
Session Reference Full AgentSession / AsyncAgentSession API
Vendor Reference Constructor options for all vendor classes
Error Reference v2.7 status codes and error reason values