Agents
Delete Agent
Soft-delete an agent. Versions and history are kept.
DELETE
/
v2
/
agents
/
{agent_id}
Delete Agent
curl --request DELETE \
--url https://api.bland.ai/v2/agents/{agent_id} \
--header 'authorization: <authorization>'import requests
url = "https://api.bland.ai/v2/agents/{agent_id}"
headers = {"authorization": "<authorization>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {authorization: '<authorization>'}};
fetch('https://api.bland.ai/v2/agents/{agent_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bland.ai/v2/agents/{agent_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.bland.ai/v2/agents/{agent_id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.bland.ai/v2/agents/{agent_id}")
.header("authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bland.ai/v2/agents/{agent_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "bc526394-c150-4983-bbfb-c84d1d9653f4",
"deleted": true
},
"errors": null
}
{
"data": null,
"errors": [
{
"error": "NOT_FOUND",
"message": "Agent not found"
}
]
}
{
"data": null,
"errors": [
{
"error": "AGENT_HAS_BOUND_WIDGETS",
"message": "This agent runs a web chat widget. Switch the widget to a prompt or pathway, then delete the agent."
}
]
}
Overview
Marks the agent deleted. It disappears from List Agents and returns404 from Get Agent, but its versions, deployments, and history are retained. Alerts scoped to the agent are deleted with it.
Phone numbers attached to the agent are detached in the same step, even when the agent is live in production. The numbers stay in your account with no agent assigned.
The delete is refused with 409 while a web widget runs the agent (AGENT_HAS_BOUND_WIDGETS) or while a GitHub repository is connected to it (CONFLICT). Switch the widget to a prompt or pathway, or disconnect the repository, then delete again.
Requires an admin, owner, operator, or prompter role.
You can also delete an agent from the dashboard. See Delete an agent.
Headers
Path Parameters
Response
{
"data": {
"id": "bc526394-c150-4983-bbfb-c84d1d9653f4",
"deleted": true
},
"errors": null
}
{
"data": null,
"errors": [
{
"error": "NOT_FOUND",
"message": "Agent not found"
}
]
}
{
"data": null,
"errors": [
{
"error": "AGENT_HAS_BOUND_WIDGETS",
"message": "This agent runs a web chat widget. Switch the widget to a prompt or pathway, then delete the agent."
}
]
}
Docs for agents: llms.txt
Was this page helpful?
⌘I
Delete Agent
curl --request DELETE \
--url https://api.bland.ai/v2/agents/{agent_id} \
--header 'authorization: <authorization>'import requests
url = "https://api.bland.ai/v2/agents/{agent_id}"
headers = {"authorization": "<authorization>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {authorization: '<authorization>'}};
fetch('https://api.bland.ai/v2/agents/{agent_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bland.ai/v2/agents/{agent_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.bland.ai/v2/agents/{agent_id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.bland.ai/v2/agents/{agent_id}")
.header("authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bland.ai/v2/agents/{agent_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "bc526394-c150-4983-bbfb-c84d1d9653f4",
"deleted": true
},
"errors": null
}
{
"data": null,
"errors": [
{
"error": "NOT_FOUND",
"message": "Agent not found"
}
]
}
{
"data": null,
"errors": [
{
"error": "AGENT_HAS_BOUND_WIDGETS",
"message": "This agent runs a web chat widget. Switch the widget to a prompt or pathway, then delete the agent."
}
]
}