Skip to main content
DELETE
/
external
/
kb
/
{kb_id}
Delete Knowledge Base
curl --request DELETE \
  --url https://prod-api.ringg.ai/ca/api/v0/external/kb/{kb_id} \
  --header 'X-API-KEY: <x-api-key>'
import requests

url = "https://prod-api.ringg.ai/ca/api/v0/external/kb/{kb_id}"

headers = {"X-API-KEY": "<x-api-key>"}

response = requests.delete(url, headers=headers)

print(response.text)
const options = {method: 'DELETE', headers: {'X-API-KEY': '<x-api-key>'}};

fetch('https://prod-api.ringg.ai/ca/api/v0/external/kb/{kb_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://prod-api.ringg.ai/ca/api/v0/external/kb/{kb_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 => [
"X-API-KEY: <x-api-key>"
],
]);

$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://prod-api.ringg.ai/ca/api/v0/external/kb/{kb_id}"

req, _ := http.NewRequest("DELETE", url, nil)

req.Header.Add("X-API-KEY", "<x-api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.delete("https://prod-api.ringg.ai/ca/api/v0/external/kb/{kb_id}")
.header("X-API-KEY", "<x-api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://prod-api.ringg.ai/ca/api/v0/external/kb/{kb_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["X-API-KEY"] = '<x-api-key>'

response = http.request(request)
puts response.read_body
{
  "message": "Knowledge Base deleted successfully",
  "kb_id": "550e8400-e29b-41d4-a716-446655440000"
}

Delete Knowledge Base

Permanently delete a knowledge base and all its associated content including files, URLs, and FAQs.
Permanent Action:
  • This operation cannot be undone
  • All associated content will be permanently deleted
  • Agents using this knowledge base will lose access to its content
  • Rate limit: Maximum 10 requests per minute per workspace

Before Deleting

Consider these steps before deleting a knowledge base:
  1. Check Agent Dependencies: Verify no active agents are using this knowledge base
  2. Backup Important Content: Download or note any critical information
  3. Review Usage: Check if the knowledge base is referenced in any campaigns

Response

On successful deletion, you’ll receive:
  • message: Confirmation message
  • kb_id: ID of the deleted knowledge base

Common Use Cases

  • Cleanup: Remove test or outdated knowledge bases
  • Reorganization: Delete before recreating with updated structure
  • Resource Management: Free up workspace resources
Agent Impact: If agents are actively using this knowledge base, they will immediately lose access. Update agent configurations before deletion to avoid disruptions.

Alternative: Edit Instead

Consider using Edit Knowledge Base instead if you only need to:
  • Remove specific files or URLs
  • Update content
  • Add new information
Editing preserves the knowledge base ID and agent associations.

Headers

X-API-KEY
string
required

(Required) Your Ringg AI API key.

Example:

"7251cb4b-3373-43a4-844c-b27a1d45e0c9"

Path Parameters

kb_id
string
required

(Required) ID of the knowledge base to delete

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Knowledge base deleted successfully.

message
string
Example:

"Knowledge Base deleted successfully"

kb_id
string
Example:

"550e8400-e29b-41d4-a716-446655440000"