API Overview
ZEGOCLOUD AI Agent server provides the following relevant API interfaces and callbacks. You can refer to Accessing Server APIs to call the interfaces below.
Agent Configuration Management
| Interface Name | Interface Function | Default Call Frequency Limit |
|---|---|---|
| Register An Agent | Register an agent (Agent) for creating an agent instance. | 10 times/second |
| Unregister An Agent | Unregister an agent. | 10 times/second |
| Update An Agent | Modify an agent. | 10 times/second |
| List Agents | Get the list of available agents. | 10 times/second |
| Query Agent Details | Get the details of a specified agent. | 10 times/second |
Agent Instance Management
| Interface Name | Interface Function | Default QPS limit |
|---|---|---|
| Create An Agent Instance | Create an agent instance and add it to text conversations and voice (RTC) conversations. | 10 times/second |
| Update An Agent Instance | Update an existing agent instance. | 10 times/second |
| Delete An Agent Instance | Delete an existing agent instance. | 10 times/second |
Agent Instance Control
| Interface Name | Interface Function | Default QPS limit |
|---|---|---|
| Trigger LLM | Trigger the LLM service as a user, and based on the response content from the LLM, proactively invoke the TTS service as an agent to send voice messages to the user. | 10 times/second |
| Trigger TTS | Trigger the TTS service as an agent to send voice messages to the user. | 10 times/second |
| Query The Status of An AI Agent Instance | Query the runtime status information of the agent during voice conversations. | 10 times/second |
| Interrupt Agent Instance | Interrupt the agent instance in a voice conversation | 10 times/second |
| Get Agent Instance Context | get the message list as context used by the agent instance during a voice conversation. | 10 times/second |
| Reset Agent Instance Context | Reset the message list as context used by the agent instance during a voice conversation. | 10 times/second |
Callbacks
| Callback Name | Callback Description |
|---|---|
| Receiving Callback | With this callback, listen to events that occur during the user's conversation with the agent. |