Agora Conversational AI API

Name: Agora Conversational AI API
Brand: Agora Conversational AI API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentCommunicationsVoice Telephonybasic8 EndpointsREST

For Agents

Install Jentic One Beta

Connect the Agora Conversational AI API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Agora Conversational AI API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Agora Conversational AI API.

Start a conversational AI agent in an Agora channel with an ASR-LLM-TTS configuration

Stop a running agent so it leaves the channel cleanly

Query agent runtime status by ID or list every running agent in a project

GET STARTED

Start building with Agora Conversational AI API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Agora Conversational AI API for, with concrete tasks.

★ Voice AI Customer Support Sessions

Support teams spin up an Agora conversational agent the moment a caller joins a channel, configuring the LLM with company knowledge and the TTS voice for the brand. The agent handles the conversation while a human supervisor can intervene by calling the interrupt endpoint, and the conversation history endpoint provides the transcript for QA or model fine-tuning.

POST /api/conversational-ai-agent/v2/projects/{appid}/join with the channel name, LLM config, and TTS voice

AI Voice Concierge in Live Apps

Consumer apps embed an Agora-powered voice agent that greets users, answers questions, and hands back to a human when needed. The /speak endpoint lets the host trigger announcements, and /interrupt yields the floor immediately. Active agent listing helps the app surface a control panel of running sessions.

POST /api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}/speak with the announcement text

Real-Time Conversation Audit

Compliance and analytics pipelines pull the conversation history endpoint as soon as an agent leaves the channel, archiving transcripts for review. Because the same endpoint works against live and finished agents, monitoring tools can poll it to provide near-real-time supervisor dashboards.

GET /api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}/history and store the transcript for review

AI Agent Voice Operations via Jentic

An orchestrating agent built on Jentic can launch, supervise, and retire Agora voice agents based on natural-language operator commands. Jentic stores the App ID and secret in its vault and applies HTTP Basic at request time, so the credentials never sit in the agent's working memory.

Use Jentic to search 'start an Agora conversational agent', execute the join, then call interrupt when a human joins

Key Endpoints

8 endpoints — jentic publishes the only available openapi specification for agora conversational ai api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/api/conversational-ai-agent/v2/projects/{appid}/join

Start a conversational AI agent

POST

/api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}/leave

Stop a running agent

GET

/api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}

Query agent status

GET

/api/conversational-ai-agent/v2/projects/{appid}/agents

List active agents

POST

/api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}/update

Update agent configuration

POST

/api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}/speak

Broadcast TTS through the agent

POST

/api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}/interrupt

Interrupt agent speech

GET

/api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}/history

Retrieve conversation history

POST

/api/conversational-ai-agent/v2/projects/{appid}/join

Start a conversational AI agent

POST

/api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}/leave

Stop a running agent

GET

/api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}

Query agent status

GET

/api/conversational-ai-agent/v2/projects/{appid}/agents

List active agents

POST

/api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}/update

Update agent configuration

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Your Agora App ID and Customer Secret are stored once, encrypted, by your own Jentic One instance as basic-auth credentials and injected at execution time. They never enter the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'start a conversational AI agent in an Agora channel', and Jentic returns the join, leave, speak, and interrupt operations with their input schemas so the agent calls the right endpoint without browsing the reference docs.

Time to first call

FAQs

Specific to using Agora Conversational AI API through Jentic.

Why is there no official OpenAPI spec for Agora Conversational AI API?

Agora does not publish an OpenAPI specification for the Conversational AI surface. Jentic generates and maintains this spec so that AI agents and developers can call the Agora Conversational AI API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

What authentication does the Agora Conversational AI API use?

HTTP Basic authentication using your Agora App ID and Customer Secret. Through Jentic, both values are stored in the credential vault and combined into the Authorization header at request time, so the agent never sees the raw secret.

How do I start a voice AI agent in an Agora channel?

Call POST /api/conversational-ai-agent/v2/projects/{appid}/join with the channel name, LLM provider configuration, ASR settings, and TTS voice. The response returns an agentId you use for all subsequent control calls.

Can I interrupt the agent while it is speaking?

Yes. POST /api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}/interrupt cuts the current TTS playback so a human or another speaker can take the floor. The agent stays joined to the channel and can resume speaking on the next /speak call.

How do I stop an Agora conversational agent through Jentic?

Search Jentic for 'stop an Agora conversational agent', load the POST /api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}/leave schema, and execute it with the project App ID and the agent ID returned by the original join call.

What are the rate limits for the Agora Conversational AI API?

The OpenAPI spec does not declare explicit per-second limits. Concurrency is bounded by your Agora project's allowance for active conversational agents - list active agents via GET /api/conversational-ai-agent/v2/projects/{appid}/agents to monitor utilisation.

Can I limit what my agent is allowed to do with the Agora Conversational AI API?

Yes. Because you run Jentic One yourself, your own rules decide which of the eight operations the agent may call and which credentials it may use. Since Agora puts the project App ID and agent ID in the URL path, you can pin the agent to a single project or a single conversational agent. You might allow it to start an agent and read conversation history while withholding the leave and interrupt operations, so it cannot end or cut off a session unless you grant those calls.

Agora Conversational AI API

Connect the Agora Conversational AI API to your agent

Capabilities

Start building with Agora Conversational AI API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs