Remove Files from Agent Knowledge Base

Removes files or text entries from an agent’s knowledge base. Use this endpoint to disassociate specific sources from an agent without deleting the underlying content. Source types: Specify the s

PATCH /ai-agents/agent-builder/agents/{uid}/knowledge-base/{sourceType}/remove

Remove Files from Agent Knowledge Base

cURL

curl --request PATCH \
  --url https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/agents/{uid}/knowledge-base/{sourceType}/remove \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "uniqueIds": [
    "60f7b3b3b3b3b3b3b3b3b3b3",
    "60f7b3b3b3b3b3b3b3b3b3b4"
  ]
}
'

import requests

url = "https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/agents/{uid}/knowledge-base/{sourceType}/remove"

payload = { "uniqueIds": ["60f7b3b3b3b3b3b3b3b3b3b3", "60f7b3b3b3b3b3b3b3b3b3b4"] }
headers = {
    "apikey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({uniqueIds: ['60f7b3b3b3b3b3b3b3b3b3b3', '60f7b3b3b3b3b3b3b3b3b3b4']})
};

fetch('https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/agents/{uid}/knowledge-base/{sourceType}/remove', 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://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/agents/{uid}/knowledge-base/{sourceType}/remove",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'uniqueIds' => [
        '60f7b3b3b3b3b3b3b3b3b3b3',
        '60f7b3b3b3b3b3b3b3b3b3b4'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/agents/{uid}/knowledge-base/{sourceType}/remove"

	payload := strings.NewReader("{\n  \"uniqueIds\": [\n    \"60f7b3b3b3b3b3b3b3b3b3b3\",\n    \"60f7b3b3b3b3b3b3b3b3b3b4\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("apikey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/agents/{uid}/knowledge-base/{sourceType}/remove")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"uniqueIds\": [\n    \"60f7b3b3b3b3b3b3b3b3b3b3\",\n    \"60f7b3b3b3b3b3b3b3b3b3b4\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/agents/{uid}/knowledge-base/{sourceType}/remove")

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

request = Net::HTTP::Patch.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"uniqueIds\": [\n    \"60f7b3b3b3b3b3b3b3b3b3b3\",\n    \"60f7b3b3b3b3b3b3b3b3b3b4\"\n  ]\n}"

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

200

{
  "success": true
}

For the complete error reference, see Error Guide.

Authorizations

apikey · string · header · required

API Key (i.e. Rest API Key from the Dashboard).

Path Parameters

uid · string · required

Unique identifier of the agent

sourceType · string · required

Source type (uploads, knowledge-base, etc.)

Body

application/json

uniqueIds · string[] · required

Array of file IDs to be added to the knowledge base

Example:

[
  "60f7b3b3b3b3b3b3b3b3b3b3",
  "60f7b3b3b3b3b3b3b3b3b3b4"
]

Response

200 - application/json

Files removed from knowledge base successfully

The response is of type object.