All recipes
PythonTypeScriptIntermediate

Gemini MLLM Voice Agent for Python

Build an end-to-end Gemini 3.8 Live MLLM voice agent with Python and Agora.

Use with Agora CLI

Clone the recipe and configure it with an Agora project.

Agora CLI
agora init my-agora-gemini-mllm-python --recipe agora-gemini-mllm-python

Recipe prompt

Paste into Cursor, Claude Code, v0, or your coding agent
Use with your coding agent
You are implementing the "Gemini MLLM Voice Agent for Python" recipe in this project.

Read the recipe markdown first:
https://raw.githubusercontent.com/AgoraIO-Community/agora-gemini-mllm-python/main/docs/ai/RECIPE.md

Use the source repository for cross-reference:
https://github.com/AgoraIO-Community/agora-gemini-mllm-python

Build this recipe into the user's app using the markdown as the implementation guide. Inspect related source files through the repository links when the recipe points to them. Ask before installing new dependencies.

Recipe

Rendered from the configured recipe markdown.

Raw
Recipe metadata
FieldValue
recipe_version1.0.0
recipe_statusexperimental
extension_points
  • id: api.routes · name: Browser-facing API routes
  • id: agent.managed-config · name: Gemini MLLM prompt, model, thinking level, VAD, and voice
  • id: web.conversation-ui · name: Conversation UI panels and controls
  • id: verification.contracts · name: Contract and local smoke verification
invariants
  • id: api.rewrite-boundary · summary: Browser calls stay on /api/* and Next rewrites to FastAPI.
  • id: secrets.server-only · summary: Agora App Certificate and BYOK keys stay in the Python backend.
  • id: token.uid-concrete · summary: Backend resolves missing, zero, or negative UIDs before issuing RTC+RTM tokens.
stable_contracts
  • id: env.required · summary: AGORA_APP_ID, AGORA_APP_CERTIFICATE, and GOOGLE_API_KEY are required by FastAPI; AGENT_BACKEND_URL is required by deployed web rewrites.
  • id: api.core-routes · summary: GET /api/get_config, POST /api/startAgent, and POST /api/stopAgent remain the browser-facing contract.
  • id: response.envelope · summary: Successful backend responses use { code, msg, data }.

Recipe Contract

This base recipe defines the reusable surface for a Python-backed Agora Conversational AI quickstart with a Next.js web client.

Recipe Role

  • Role: base quickstart recipe.
  • Target audience: developers bootstrapping a production-style Conversational AI app with a Python FastAPI backend and Next.js web client.
  • Reuse model: keep this demo beside the local Python SDK checkout, configure three secrets, run, then customize the MLLM or UI.

Recipe Scope

This base recipe provides a copyable split-process starter with:

  • Python FastAPI token generation and managed agent lifecycle.
  • Next.js browser UI with RTC audio, RTM events, transcript, metrics, and connection status.
  • Rewrite-only /api/* browser facade that hides backend placement.
  • One Gemini 3.8 MLLM handles voice end to end; there is no separate STT, LLM, or TTS stage.
  • Contract and local smoke verification that do not require live Agora calls.

Baseline Implementation Guidance

This Gemini demo is adapted from the Python-backed Agora quickstart. Use its source and progressive disclosure docs as the starting point for further customization.

Do not recreate Agora ConvoAI integration from memory. Provider schemas, SDK builder fields, token behavior, and RTM event details can drift. For a new baseline implementation, follow L1/L2/from_scratch_bootstrap.md while copying verified patterns from this repo.

Extension Points

IDSurfaceHow to extendRequired follow-up
api.routesserver/src/server.py, web/next.config.ts, web/src/services/api.tsAdd FastAPI route, add rewrite, add browser fetch helper.Extend web/scripts/verify-api-contracts.ts; add smoke coverage if the route belongs in local verification.
agent.managed-configserver/src/agent.pyChange ADA_PROMPT, DEMO_GREETING, voice, or session options. The browser selects the public model and optional low/medium/high thinking level.Run backend and local FastAPI checks; keep secrets in server/.env.example.
web.conversation-uiweb/src/components/*, web/src/lib/conversation.tsCustomize pre-call, transcript, metrics, connection status, microphone, or visualizer UI.Preserve RTC/RTM lifecycle ownership and transcript UID normalization.
verification.contractsweb/scripts/*.ts, root package.jsonAdd contract checks for new browser/backend boundaries.Keep checks runnable without live Agora credentials where possible.

Invariants

  • Browser code calls only /api/get_config, /api/startAgent, and /api/stopAgent for the default recipe flow.
  • Next.js owns the browser-facing /api/* paths only through rewrites; do not add web/app/api/**/route.ts for agent or token logic.
  • FastAPI owns token generation, AGORA_APP_CERTIFICATE, BYOK provider keys, and agent lifecycle.
  • The backend returns one RTC+RTM-capable token from get_config; it must be issued for a concrete non-zero UID.
  • LandingPage.tsx coordinates config fetch, agent start, RTM login, token renewal, and call teardown.
  • ConversationComponent.tsx owns RTC join, microphone publish, AgoraVoiceAI initialization, transcript/state/metrics listeners, and explicit end-call media release.
  • The Google API key stays server-side; the Gemini MLLM and its prompt stay in the FastAPI agent configuration.

Stable Contracts

ContractStable shape
Required backend envAGORA_APP_ID, AGORA_APP_CERTIFICATE, GOOGLE_API_KEY
Backend portPass PORT only at launch; the default is 8000.
Required web deploy envAGENT_BACKEND_URL
GET /api/get_configQuery channel?, uid?; returns data.app_id, data.token, data.uid, data.channel_name, data.agent_uid.
POST /api/startAgentBody { channelName, rtcUid, userUid, model, thinkingLevel?, parameters? }; thinking is valid only for Extended Thinking; returns data.agent_id, data.channel_name, data.status.
POST /api/stopAgentBody { agentId }; returns { code: 0, msg: "success" }.
Success envelope{ "code": 0, "msg": "success", "data": ... } where route has data.
Verification entry pointsbun run verify:web, bun run verify:backend, bun run verify:web:proxy, bun run verify:local:fastapi, bun run verify:local.

Internal / Subject to Change

  • Exact visual layout, component composition, Tailwind classes, and asset choices under web/src/components/.
  • Gemini model IDs, thinking defaults, VAD timing, voice IDs, and prompt text; update docs and tests when changing them.
  • In-memory Agent._sessions implementation details; the stable behavior is start by channel/user and stop by returned agent_id.
  • Verification implementation internals under web/scripts/; the stable surface is the root script names and what they assert.
  • agora-agents SDK minor-version behavior; this recipe lower-bounds v2 but does not freeze every SDK field.
  • L1/01_setup.md — setup, env, and command reference.
  • L1/02_architecture.md — request flow and component topology.
  • L1/05_workflows.md — common modification workflows.
  • L1/06_interfaces.md — route, rewrite, env, and event contracts.
  • L1/L2/from_scratch_bootstrap.md — implementation map for recreating the Python-backed quickstart recipe.
  • L1/L2/managed_agent_config.md — full agent config detail.
  • L1/L2/session_lifecycle.md — RTC/RTM/session orchestration.