Copy Create JSON - Copy the complete agent configuration JSON to clipboard for creating a new agent
Copy Update JSON - Copy the update configuration JSON to clipboard for updating an existing agent

AI Agent

AI Avatar
Your unique identifier in the Agora channel. Required when using tokens or AI Avatar.
Authentication token for Agora RTC. Required if your project has token authentication enabled.

Live Subtitles

Toggle the subtitle overlay to show real-time transcription of the conversation
Subtitle Mode:

Chat History

Real-time conversation history between you and the AI agent. Messages are displayed as they occur.
Copy or clear the chat history. Copy saves the conversation to clipboard, Clear removes all messages.

Query Agents

Enter the ID of the agent you want to query
Get the current status of the specified Conversational AI agent instance. Shows status like IDLE, STARTING, RUNNING, STOPPING, STOPPED, RECOVERING, or FAILED.
Get a list of Conversational AI agents that meet the specified conditions. Can filter by channel, time range, state, and limit results.
Retrieve the conversation history between the user and the Conversational AI agent while the agent is running. Shows messages with role (user/assistant) and content.
Advanced filters only apply to "Retrieve Agent List". Fill only the fields you need - all fields are optional.

Send Messages

Type a text message to send to the agent. Press Enter or click Send to submit. Disabled when RTM is not enabled.
Enter a URL to an image to send to the agent for analysis. Press Enter or click Send to submit. Disabled when camera is active.
Upload an image file to send to the agent for analysis. The image will be converted to base64. Disabled when camera is active.

Broadcast Messages

Enter a message to broadcast to all users in the channel. Maximum 512 characters.
Message priority: INTERRUPT (stop current activity), APPEND (add to queue), IGNORE (skip if busy)
Whether this message can interrupt the agent's current activity
Click to expand/collapse SIP calling and phone number management options. When expanded, the regular Create/Stop Agent buttons are disabled. Collapse this section to re-enable them.

Signaling Requirements for Live Subtitles

Choose Your Subtitle Mode

You have two options for live subtitles:

RTM Mode (Full Features)

Requires RTM to be enabled on your Agora AppID. Supports both viewing transcripts and sending messages.

Data Stream Mode (View Only)

Uses RTC data stream. No RTM required. View transcripts only, cannot send messages.

Setup Requirements

  • Enable Signaling: Your Agora AppID must have signaling (RTM) enabled
  • Dual Tokens: Both client and agent need a single token that works for both RTC and RTM
  • Token Authentication: Signaling requires token-based authentication
  • Channel Access: Both users must join the same RTM channel

What Happens Without Signaling

If signaling is not properly configured:

  • Transcription data cannot be transmitted
  • Live subtitles will not appear
  • The agent cannot receive speech recognition results
  • Real-time conversation features will be limited

Important Note

Both the client and agent need to be configured with a single token that works for both RTC and RTM for live subtitles to work properly. The transcription system relies on RTM to deliver real-time speech recognition data.

How to Enable Signaling

  1. Go to your Agora Console
  2. Navigate to your project settings
  3. Enable "Signaling" or "RTM" service
  4. Generate a single token that works for both RTC and RTM
  5. Configure your client application to use this dual-purpose token