Agents Platform

Delete Agent

Changed on

Delete an agent

delete/v1/convai/agents/{agent_id}

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/convai/agents/{agent_id}
  • Auth
    none declared

Path parameters

agent_idstring required

The id of an agent. This is returned on agent creation.

Example:agent_3701k3ttaq12ewp8b7qv5rfyszkz

Query parameters

forceboolean

If set to true, the agent is deleted even if other agents use it as a subagent, and it is removed from those agents and their branches.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

Changes

  • dd891c92ba97Revision changes
    • info

      added the new optional query request parameter force

  • 5b595807512cRevision changes
    • info

      api operation id Delete_Agent_v1_convai_agents__agent_id__delete removed and replaced with delete_agent_route

    • info

      api tag Agents Platform added

    • info

      api tag Conversational AI removed