Delete an agent

Updated

Deletes a saved agent.

Preview documentation

You're reading the Conversational AI Platform (Preview) docs. Switch to Main.
DELETE
https://preview.ai.agora.io/conversational-ai/v1/projects/{appid}/agents/{agent_id}

You can't delete an agent that a phone number routes inbound calls to, or that a campaign that hasn't finished uses. Remove those references first.

Path Parameters

appidstring
Required

The App ID of your project.

agent_idstring
Required

The ID of the agent, returned in agent_id when you create the agent.

Response Body

The agent was deleted.

Response Headers

Agora-Request-Idstring

A unique ID for the request. Include it when you contact Agora support.

deletedboolean
Required

Always true. The resource is deleted.

Authorization

This endpoint requires authentication.

Request examples

Example Request
curl -X DELETE 'https://preview.ai.agora.io/conversational-ai/v1/projects/string/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08'

Response example

Example Response
{  "deleted": true}