Voice Agent Overview

Updated

Create and manage agents, and troubleshoot Voice Agent REST API requests.

The Voice Agent REST API lets you create, stop, update, query, interrupt, and inspect agent sessions from your server.

API basics

All requests are sent to the host api.agora.io.

  • Authentication: Use RESTful authentication for every request.
  • Request: Request and response bodies use JSON.
  • Base URL: https://api.agora.io/api/conversational-ai-agent/v2/projects/<appid>, where <appid> is the Agora App ID for your project.

Request URLs and request bodies are case-sensitive.

REST APIs

Client toolkit

The client toolkit helps you build Voice Agent app clients with APIs that combine Agora RTC and Signaling capabilities for message subscription, conversation events, interruption, transcript updates, image messages, and audio best-practice settings.

  • Android toolkit API: Reference for Android toolkit classes, callbacks, structures, and enums.
  • iOS toolkit API: Reference for iOS toolkit classes, callbacks, structures, and enums.
  • Web toolkit API: Reference for Web toolkit classes, event handlers, types, interfaces, and enums.