v2.4.1

Release v2.4.1

v2.4.0

Added

• Area-aware default ASR vendor selection — The default ASR vendor is now chosen based on the client area, with updated documentation and tests.
• New engine API vendors — Adapted agentkit to the new engine API vendors, with refreshed vendor and regional routing guides.

Changed

• Gemini / Vertex LLM configuration — Aligned Gemini and Vertex LLM config handling; the URL is now always included in Gemini and Vertex LLM configurations, and project_id, location, and adc_credentials_string are passed under params in the VertexAI configuration.

Fixed

• Avatar configurations — SenseTimeAvatar now treats sceneList as optional, and AnamAvatar requires avatar_id instead of persona_id.

v2.3.0

Added

• CN vendor support — Area-aware Agora/AsyncAgora clients and Agent builders (CNAgent/GlobalAgent) with a CN vendor catalog and CN/global API routing. The bound client does not enforce area/vendor compatibility, so CN and global vendors can be mixed.
• SenseTime avatar — Added SenseTimeAvatar configuration and validation.

Changed

• turn_detection accepts a dict — Agent(turn_detection=...) now also accepts a plain mapping in addition to the typed config; it is coerced into the request model when the start request is built.

Fixed

• Python 3.8 compatibility — Replaced PEP 585 builtin generics (list[...]) in the new vendor models with typing equivalents so pydantic can build the models on Python 3.8.

v2.2.0

Added

• Expanded provider surface — Added generated API support for the latest Conversational AI vendors and configuration types, including Dify LLM and Generic Avatar.
• Interaction language handling — AgentKit now consistently derives REST asr.language from turn_detection.language while keeping provider-specific STT language values under asr.params.
• Deepgram keyterm — Added keyterm support on DeepgramSTT, serialized as asr.params.keyterm.

Changed

• MiniMax managed presets — MiniMax preset-backed TTS now keeps the preset model as an internal hint while sending only supported partial TTS settings such as voice_setting.voice_id.
• Vertex AI LLM routing — VertexAILLM now keeps project and location in the generated endpoint URL instead of duplicating them in llm.params.

Fixed

• Provider wire keys — Corrected alias-sensitive TTS payloads so Google TTS emits VoiceSelectionParams and AudioConfig, Rime TTS emits modelId, and Murf TTS preserves voiceId.
• AgentKit request validation — Start request validation now de-aliases REST-shaped provider dictionaries before constructing generated request models, while still allowing preset and pipeline-backed partial configs.
• Request body coverage — Added regression tests for BYOK, preset-backed, mixed preset/BYOK, and pipeline override request shapes across provider configurations.
• Python docs examples — Added a docs guard to keep Python examples on snake_case kwargs while allowing documented JSON wire keys.

v2.1.1

Release v2.1.1

v2.1.0

Added

• Turn detection language — AgentKit now manages Agora interaction language through turn_detection.language, validates it against the supported BCP-47 language list, and sends the default en-US when no language is provided.
• Provider parameter parity — ASR, LLM, MLLM, TTS, and avatar wrappers expose typed provider parameters plus passthrough fields where the generated core supports additional properties.

Changed

• Generated core refresh — Regenerated core types from the v2.1 API schema.
• Deepgram TTS passthrough — DeepgramTTS now uses additional_params for passthrough fields and flattens them into tts.params; the removed nested params.params shape is no longer documented or emitted.
• OpenAI TTS — Docs and tests now reflect the generated core shape, including instructions and speed under tts.params.
• TTS provider docs — Updated TTS provider reference tables to match implemented wrapper fields and generated core params.

Fixed

• Managed-provider validation — AgentKit validation now distinguishes preset-backed providers from BYOK providers so required provider fields are only required when credentials are caller-supplied.
• Language placement — Provider-specific STT language values remain under asr.params, while Agora interaction language is emitted separately as turn_detection.language.

v2.0.0

Added

• Type aliases — AsrConfig (= SttConfig), is_avatar_token_managed, think type aliases (ThinkOnListeningAction, etc.), and think value constants.
• XaiGrok — New MLLM wrapper for xAI Grok (mllm.vendor: "xai"), including Realtime API URL, voice, language, sample rate, modalities, messages, and MLLM turn detection support.
• GenericAvatar — New generic avatar wrapper (vendor: "generic") for custom avatar providers.
• Avatar token enrichment — AgentSession.start() now fills missing generic avatar agora_appid and agora_channel from the session and generates missing avatar agora_token values for HeyGen, LiveAvatar, and Generic avatars using each avatar's agora_uid.
• Turn pagination — AgentSession.get_turns() and AsyncAgentSession.get_turns() now accept page_index and page_size. New get_all_turns() helpers fetch and combine all pages.
• Greeting interruption control — LLM vendor greeting_configs now accepts the typed LlmGreetingConfigs shape, including v2.7 interruptable.
• Type alias parity — Added public aliases for v2.7 generated types such as LlmConfig, TtsConfig, SttConfig, MllmConfig, AvatarConfig, AgentConfigUpdate, ConversationTurns, ConversationHistory, SessionInfo, Labels, SpeakPriority, and FillerWordsContentSelectionRule.

Changed

• ConvoAI token options — generate_convo_ai_token() now accepts an integer uid and handles the internal token string conversion for users, agents, and avatars.
• Avatar token generation — Removed the dedicated generate_avatar_rtc_token() wrapper; avatar RTC tokens use the existing ConvoAI token helper.
• Avatar token gating — Session enrichment uses is_avatar_token_managed (vendor-only); UID checks remain in session logic.
• XaiGrok is the primary xAI MLLM class — Matches the product name (xAI Grok) and the TypeScript/Go SDKs.
• Package version — Bumped to v2.0.0 to match the Fern-generated SDK headers.
• PyPI distribution rename — The published package name is now agora-agents (formerly agora-agent-server-sdk). The Python import path remains agora_agent.
• RTM data channel default — When advanced_features.enable_rtm=True, AgentKit now defaults parameters.data_channel to "rtm" unless the caller explicitly sets a data channel.
• Agent-level LLM overrides — In the standard ASR + LLM + TTS pipeline, agent-level greeting, failure_message, and max_history now override vendor defaults, matching the TypeScript SDK. In MLLM mode, agent-level greeting and failure_message fill only missing fields.
• MLLM core alignment — MLLM wrappers no longer expose or emit unsupported predefined_tools or max_history fields because they are not present in the generated v2.7 core mllm type.
• MLLM without TTS — MLLM sessions no longer require separate TTS, STT, or LLM vendor configuration.
• Avatar pipeline support — Avatar vendors are now explicitly limited to the cascading ASR + LLM + TTS pipeline. Combining with_avatar() with with_mllm() is rejected at Agent.to_properties() and AgentSession.start() (matching the TypeScript SDK), with a disabled avatar (enable=False) still permitted alongside MLLM.
• VertexAI parity — VertexAI.to_config() now spreads additional_params first so explicit model, project_id, location, and adc_credentials_string fields always win, matching the TypeScript and Gemini Live wrappers.
• Pagination guard parity — AgentSession.get_all_turns() and AsyncAgentSession.get_all_turns() now raise RuntimeError if the server's pagination metadata is missing (page_index/total_pages/is_last_page) or if the next page does not advance, matching the TypeScript SDK.

Migration notes

• PyPI package rename — Install agora-agents instead of agora-agent-server-sdk (pip install agora-agents or poetry add agora-agents). The import path is unchanged (from agora_agent import ...). The legacy PyPI distribution name remains available as a compatibility shim that re-exports the public API from agora-agents.

• Deprecated aliases — Use LiveAvatarAvatar instead of HeyGenAvatar, is_avatar_token_managed instead of is_rtc_avatar, and ThinkOn* / ThinkResponse instead of AgentThinkRequestOn* / AgentThinkResponse.

• think() default — The server default for on_listening_action changed from inject to interrupt in API v2.7. Pass on_listening_action="inject" explicitly to preserve the old behavior.

• Turn analytics pagination — Sessions with more than 50 turns must request additional pages via get_turns(page_index=..., page_size=...) or use get_all_turns().

• Error reasons — API v2.7 adds status codes 401, 429, and 500; InvalidRequest is split into InvalidRequestBody, MissingRequiredField, and InvalidFieldValue, with new reasons such as ServiceNotEnabled, AccountSuspended, and ResourceAllocationFailed.

• Event 112 — Webhook event 112 turns finished can be used as an alternative batch delivery path for post-session turn data.

v1.4.1

Fixed

• Release workflow — Publish to PyPI with the PYPI_API_TOKEN secret.

v1.4.0

Added

• DeepgramTTS — New TTS vendor wrapper for Deepgram (Beta). Accepts api_key, model, base_url, sample_rate, params, and skip_patterns.
• Agent.with_tools(enabled=True) — Dedicated builder method to enable MCP tool invocation (advanced_features.enable_tools). Replaces the raw with_advanced_features(AdvancedFeatures(enable_tools=True)) call.
• LLM vendors: headers field — All four LLM vendors (OpenAI, AzureOpenAI, Anthropic, Gemini) now accept an optional headers: Dict[str, str] parameter. Use this to pass custom HTTP headers to the LLM provider (e.g., tenant identifiers, routing headers).
• AgentSession.think() / AsyncAgentSession.think() — Send a custom instruction to a running agent through the agent_management API.
• Agent.with_interruption() — Configure the new top-level interruption object for unified interruption control.
• MLLM turn detection — OpenAIRealtime, GeminiLive, and VertexAI now accept turn_detection, which maps to mllm.turn_detection and overrides top-level turn detection for MLLM sessions.
• audio_scenario AgentKit support — SessionParams and AgentKit request construction now expose the top-level parameters.audio_scenario field.
• MLLM vendor parity — GeminiLive is documented and exposed as the direct Google Gemini Live API wrapper.

Fixed

• MiniMax TTS preset stripping — When a MiniMax reseller preset is inferred (minimax_speech_2_6_turbo or minimax_speech_2_8_turbo), the group_id and url fields are now correctly stripped from tts.params alongside key and model. Previously they were forwarded to the API, causing request failures.
• MLLM enable flag — Agent.with_mllm() now sets mllm.enable = True and removes the deprecated advanced_features.enable_mllm flag from generated requests.
• MLLM wrapper shape — MLLM vendors no longer emit removed fields such as style; docs and tests now reflect the v2.6 MLLM contract.
• Preset-backed OpenAI TTS — OpenAITTS no longer requires api_key when a reseller preset supplies credentials server-side.
• AgentKit parity coverage — Added regression coverage for interruption, MLLM turn detection, Deepgram TTS, LLM headers, and deprecated MLLM flag cleanup.

v1.3.2

v1.3.2