Delete documents
curl --request POST \
--url https://api.statisfy.com/v1/knowledge_bases/{knowledge_base_id}/documents/batch/delete \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"external_ids": [
"<string>"
],
"ids": [
"<string>"
]
}
'import requests
url = "https://api.statisfy.com/v1/knowledge_bases/{knowledge_base_id}/documents/batch/delete"
payload = {
"external_ids": ["<string>"],
"ids": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({external_ids: ['<string>'], ids: ['<string>']})
};
fetch('https://api.statisfy.com/v1/knowledge_bases/{knowledge_base_id}/documents/batch/delete', 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.statisfy.com/v1/knowledge_bases/{knowledge_base_id}/documents/batch/delete",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'external_ids' => [
'<string>'
],
'ids' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.statisfy.com/v1/knowledge_bases/{knowledge_base_id}/documents/batch/delete"
payload := strings.NewReader("{\n \"external_ids\": [\n \"<string>\"\n ],\n \"ids\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.post("https://api.statisfy.com/v1/knowledge_bases/{knowledge_base_id}/documents/batch/delete")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"external_ids\": [\n \"<string>\"\n ],\n \"ids\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.statisfy.com/v1/knowledge_bases/{knowledge_base_id}/documents/batch/delete")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_ids\": [\n \"<string>\"\n ],\n \"ids\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"ref": "<string>",
"status": "deleted",
"document_id": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{}
]
}
}
]
}knowledge_bases
Delete documents
Deletes up to 100 documents named by ids, external_ids, or both, with a result for each: deleted, or failed when the knowledge base has no such document. There is no ‘replace everything’ sync: delete what your source removed. Each counts against your rate limit. Writes go into a knowledge base this API made or one that takes uploads in the app (writable); a connector’s is a 409. A digital worker’s own key can’t write.
POST
/
v1
/
knowledge_bases
/
{knowledge_base_id}
/
documents
/
batch
/
delete
Delete documents
curl --request POST \
--url https://api.statisfy.com/v1/knowledge_bases/{knowledge_base_id}/documents/batch/delete \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"external_ids": [
"<string>"
],
"ids": [
"<string>"
]
}
'import requests
url = "https://api.statisfy.com/v1/knowledge_bases/{knowledge_base_id}/documents/batch/delete"
payload = {
"external_ids": ["<string>"],
"ids": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({external_ids: ['<string>'], ids: ['<string>']})
};
fetch('https://api.statisfy.com/v1/knowledge_bases/{knowledge_base_id}/documents/batch/delete', 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.statisfy.com/v1/knowledge_bases/{knowledge_base_id}/documents/batch/delete",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'external_ids' => [
'<string>'
],
'ids' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.statisfy.com/v1/knowledge_bases/{knowledge_base_id}/documents/batch/delete"
payload := strings.NewReader("{\n \"external_ids\": [\n \"<string>\"\n ],\n \"ids\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.post("https://api.statisfy.com/v1/knowledge_bases/{knowledge_base_id}/documents/batch/delete")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"external_ids\": [\n \"<string>\"\n ],\n \"ids\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.statisfy.com/v1/knowledge_bases/{knowledge_base_id}/documents/batch/delete")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_ids\": [\n \"<string>\"\n ],\n \"ids\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"ref": "<string>",
"status": "deleted",
"document_id": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{}
]
}
}
]
}Authorizations
An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.
Body
application/json
Was this page helpful?