Delete Knowledge Base Document

Delete Knowledge Base Document By Id

curl --request DELETE \
  --url https://api.xpander.ai/v1/knowledge/{kb_id}/documents/{document_id} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.xpander.ai/v1/knowledge/{kb_id}/documents/{document_id}"

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

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

print(response.text)

const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.xpander.ai/v1/knowledge/{kb_id}/documents/{document_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.xpander.ai/v1/knowledge/{kb_id}/documents/{document_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: <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://api.xpander.ai/v1/knowledge/{kb_id}/documents/{document_id}"

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

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.xpander.ai/v1/knowledge/{kb_id}/documents/{document_id}")

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

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

response = http.request(request)
puts response.read_body

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

DELETE

knowledge

{kb_id}

documents

{document_id}

Delete Knowledge Base Document By Id

curl --request DELETE \
  --url https://api.xpander.ai/v1/knowledge/{kb_id}/documents/{document_id} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.xpander.ai/v1/knowledge/{kb_id}/documents/{document_id}"

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

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

print(response.text)

const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.xpander.ai/v1/knowledge/{kb_id}/documents/{document_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.xpander.ai/v1/knowledge/{kb_id}/documents/{document_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: <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://api.xpander.ai/v1/knowledge/{kb_id}/documents/{document_id}"

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

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.xpander.ai/v1/knowledge/{kb_id}/documents/{document_id}")

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

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

response = http.request(request)
puts response.read_body

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Knowledge bases are replaced by the Company Brain. Knowledge bases in use move into brains automatically, and these calls keep working on a moved knowledge base for one release. For new content, use collections.

Permanently remove a document from a knowledge base. This deletes the document file, all extracted chunks, and vector embeddings.

Path Parameters

string

required

Unique identifier of the knowledge base (UUID format)

string

required

Unique identifier of the document to delete (UUID format)

Response

Returns 202 Accepted with {"ok": true}.

Example Request

curl -X DELETE -H "x-api-key: <your-api-key>" \
  https://api.xpander.ai/v1/knowledge/<kb-id>/documents/<document-id>

Example Response

HTTP/1.1 202 Accepted
Content-Type: application/json

{"ok": true}

Notes

This action cannot be undone
All vector embeddings for this document will be removed from search
Agents using this knowledge base will no longer have access to this document’s content
The document file itself is permanently deleted from storage
Returns 404 if the document or knowledge base is not found

Authorizations

x-api-key

string

header

required

API Key for authentication

Path Parameters

kb_id

string

required

document_id

string

required

Response

Successful Response

Overview

REST API - Conversations

REST API - Agents

REST API - Tasks

Agent Workspace

REST API - Knowledge

REST API - Skills

REST API - Workflows

REST API - Custom Functions

REST API - Scheduled Tasks

REST API - Self-Schedules

REST API - Misc

Channels and webhooks

Advanced

Delete Knowledge Base Document

Path Parameters

Response

Example Request

Example Response

Notes

Authorizations

Path Parameters

Response

​Path Parameters

​Response

​Example Request

​Example Response

​Notes

Authorizations

Path Parameters

Response

Path Parameters

Response

Example Request

Example Response

Notes