logo
Console
AI Agent
Server
Introduction
Overview
Release Notes
Quick Start
Quick Start Voice Call
Quick Start Digital Human Video Call
Basic
Display Subtitles
Display User And Agent Status
Get AI Agent Status and Latency Data
Configure LLM
Proactive Invocation of LLM and TTS
Configure ASR Hot Word
Interrupt Agent
Advanced
Speech Segmentation Control
AI Short-Term Memory Management
Best Practices
Role-Playing System Prompt
Clone Voice
Interact with AI in IM and make voice calls
API Reference
Overview
Accessing Server APIs
Call API Online
Return Codes
Agent Configuration Management
POST
Register Agent
POST
Unregister Agent
POST
Update Agent
POST
List Agents
POST
Query Agents Details
Agent Instance Management
POST
Create Agent Instance
POST
Create Digital Human Agent Instance
POST
Update Agent Instance
POST
Delete Agent Instance
Agent Instance Control
POST
Trigger LLM
POST
Trigger TTS
POST
Query The Status of An AI Agent Instance
POST
Interrupt Agent Instance
POST
Get Agent Instance Context
POST
Reset Agent Instance Context
Callback
Receiving Callback
Exception Event Codes
FAQ
On this page

UnregisterAgent

POST

https://aigc-aiagent-api.zegotech.cn/

By calling this API, you can unregister an AI agent.

Request

Query Parameters

    Action stringrequired

    Possible values: [UnregisterAgent]

    API Prototype Parameter

    https://aigc-aiagent-api.zegotech.cn?Action=UnregisterAgent

    AppId uint32required

    The unique Application ID assigned to your project by ZEGOCLOUD. Get it from the ZEGOCLOUD Admin Console.

    SignatureNonce stringrequired

    Random string.

    Timestamp int64required

    Unix timestamp, in seconds. The maximum allowed error is 10 minutes.

    Signature stringrequired

    Signature, used to verify the legitimacy of the request. Refer to Signing the requests for how to generate an API request signature.

    SignatureVersion stringrequired

    Possible values: [2.0]

    Signature version number, default value is 2.0.

Body

required
    AgentId stringrequired

    The unique identifier of the registered AI agent.

Responses​

Success
Schema
    Code integer

    Return code. 0 indicates success, other values indicate failure. For more information on error codes and response handling recommendations, please refer to Return Codes.

    Message string

    Explanation of the request result

    RequestId string

    Request ID
1
Copied!
Request
Collapse all
Base URL
https://aigc-aiagent-api.zegotech.cn
Unified access address (no regional distinction)
Parameters
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
Bodyrequired
{

  "AgentId": "Jacky"

}
RESPONSEClear

Click the "Send" button above and see the response here!

Previous

Register Agent

Next

Update Agent

On this page

Back to top