Update Knowledge Base Document
curl --request PATCH \
--url https://api.example.com/v1/knowledge-bases/{knowledge_base_id}/document/{document_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"summary": "<string>",
"short_summary": "<string>",
"doc_type": "<string>",
"error": {},
"warnings": [
{
"detail": "<string>",
"node_id": "<string>",
"params": {},
"markdown": "<string>",
"snippet": "<string>"
}
],
"prefix": "<string>",
"file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dismissed": true,
"needs_reingestion": true
}
'import requests
url = "https://api.example.com/v1/knowledge-bases/{knowledge_base_id}/document/{document_id}"
payload = {
"name": "<string>",
"summary": "<string>",
"short_summary": "<string>",
"doc_type": "<string>",
"error": {},
"warnings": [
{
"detail": "<string>",
"node_id": "<string>",
"params": {},
"markdown": "<string>",
"snippet": "<string>"
}
],
"prefix": "<string>",
"file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dismissed": True,
"needs_reingestion": True
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
summary: '<string>',
short_summary: '<string>',
doc_type: '<string>',
error: {},
warnings: [
{
detail: '<string>',
node_id: '<string>',
params: {},
markdown: '<string>',
snippet: '<string>'
}
],
prefix: '<string>',
file_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
dismissed: true,
needs_reingestion: true
})
};
fetch('https://api.example.com/v1/knowledge-bases/{knowledge_base_id}/document/{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.example.com/v1/knowledge-bases/{knowledge_base_id}/document/{document_id}",
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([
'name' => '<string>',
'summary' => '<string>',
'short_summary' => '<string>',
'doc_type' => '<string>',
'error' => [
],
'warnings' => [
[
'detail' => '<string>',
'node_id' => '<string>',
'params' => [
],
'markdown' => '<string>',
'snippet' => '<string>'
]
],
'prefix' => '<string>',
'file_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'dismissed' => true,
'needs_reingestion' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/knowledge-bases/{knowledge_base_id}/document/{document_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"summary\": \"<string>\",\n \"short_summary\": \"<string>\",\n \"doc_type\": \"<string>\",\n \"error\": {},\n \"warnings\": [\n {\n \"detail\": \"<string>\",\n \"node_id\": \"<string>\",\n \"params\": {},\n \"markdown\": \"<string>\",\n \"snippet\": \"<string>\"\n }\n ],\n \"prefix\": \"<string>\",\n \"file_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dismissed\": true,\n \"needs_reingestion\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<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://api.example.com/v1/knowledge-bases/{knowledge_base_id}/document/{document_id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"summary\": \"<string>\",\n \"short_summary\": \"<string>\",\n \"doc_type\": \"<string>\",\n \"error\": {},\n \"warnings\": [\n {\n \"detail\": \"<string>\",\n \"node_id\": \"<string>\",\n \"params\": {},\n \"markdown\": \"<string>\",\n \"snippet\": \"<string>\"\n }\n ],\n \"prefix\": \"<string>\",\n \"file_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dismissed\": true,\n \"needs_reingestion\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/knowledge-bases/{knowledge_base_id}/document/{document_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"summary\": \"<string>\",\n \"short_summary\": \"<string>\",\n \"doc_type\": \"<string>\",\n \"error\": {},\n \"warnings\": [\n {\n \"detail\": \"<string>\",\n \"node_id\": \"<string>\",\n \"params\": {},\n \"markdown\": \"<string>\",\n \"snippet\": \"<string>\"\n }\n ],\n \"prefix\": \"<string>\",\n \"file_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dismissed\": true,\n \"needs_reingestion\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"summary": "<string>",
"error": {},
"updated_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"size": 123,
"short_summary": "<string>",
"doc_type": "<string>",
"source_metadata": {},
"content_type": "<string>",
"has_conversion": true,
"doc_metadata": {},
"name": "<string>",
"prefix": "<string>",
"uri": "<string>",
"file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dismissed": true,
"warnings": [
"<unknown>"
],
"needs_reingestion": true
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Knowledge Base
Update Knowledge Base Document
Update a document in a knowledge base
PATCH
/
v1
/
knowledge-bases
/
{knowledge_base_id}
/
document
/
{document_id}
Update Knowledge Base Document
curl --request PATCH \
--url https://api.example.com/v1/knowledge-bases/{knowledge_base_id}/document/{document_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"summary": "<string>",
"short_summary": "<string>",
"doc_type": "<string>",
"error": {},
"warnings": [
{
"detail": "<string>",
"node_id": "<string>",
"params": {},
"markdown": "<string>",
"snippet": "<string>"
}
],
"prefix": "<string>",
"file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dismissed": true,
"needs_reingestion": true
}
'import requests
url = "https://api.example.com/v1/knowledge-bases/{knowledge_base_id}/document/{document_id}"
payload = {
"name": "<string>",
"summary": "<string>",
"short_summary": "<string>",
"doc_type": "<string>",
"error": {},
"warnings": [
{
"detail": "<string>",
"node_id": "<string>",
"params": {},
"markdown": "<string>",
"snippet": "<string>"
}
],
"prefix": "<string>",
"file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dismissed": True,
"needs_reingestion": True
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
summary: '<string>',
short_summary: '<string>',
doc_type: '<string>',
error: {},
warnings: [
{
detail: '<string>',
node_id: '<string>',
params: {},
markdown: '<string>',
snippet: '<string>'
}
],
prefix: '<string>',
file_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
dismissed: true,
needs_reingestion: true
})
};
fetch('https://api.example.com/v1/knowledge-bases/{knowledge_base_id}/document/{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.example.com/v1/knowledge-bases/{knowledge_base_id}/document/{document_id}",
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([
'name' => '<string>',
'summary' => '<string>',
'short_summary' => '<string>',
'doc_type' => '<string>',
'error' => [
],
'warnings' => [
[
'detail' => '<string>',
'node_id' => '<string>',
'params' => [
],
'markdown' => '<string>',
'snippet' => '<string>'
]
],
'prefix' => '<string>',
'file_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'dismissed' => true,
'needs_reingestion' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/knowledge-bases/{knowledge_base_id}/document/{document_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"summary\": \"<string>\",\n \"short_summary\": \"<string>\",\n \"doc_type\": \"<string>\",\n \"error\": {},\n \"warnings\": [\n {\n \"detail\": \"<string>\",\n \"node_id\": \"<string>\",\n \"params\": {},\n \"markdown\": \"<string>\",\n \"snippet\": \"<string>\"\n }\n ],\n \"prefix\": \"<string>\",\n \"file_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dismissed\": true,\n \"needs_reingestion\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<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://api.example.com/v1/knowledge-bases/{knowledge_base_id}/document/{document_id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"summary\": \"<string>\",\n \"short_summary\": \"<string>\",\n \"doc_type\": \"<string>\",\n \"error\": {},\n \"warnings\": [\n {\n \"detail\": \"<string>\",\n \"node_id\": \"<string>\",\n \"params\": {},\n \"markdown\": \"<string>\",\n \"snippet\": \"<string>\"\n }\n ],\n \"prefix\": \"<string>\",\n \"file_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dismissed\": true,\n \"needs_reingestion\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/knowledge-bases/{knowledge_base_id}/document/{document_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"summary\": \"<string>\",\n \"short_summary\": \"<string>\",\n \"doc_type\": \"<string>\",\n \"error\": {},\n \"warnings\": [\n {\n \"detail\": \"<string>\",\n \"node_id\": \"<string>\",\n \"params\": {},\n \"markdown\": \"<string>\",\n \"snippet\": \"<string>\"\n }\n ],\n \"prefix\": \"<string>\",\n \"file_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dismissed\": true,\n \"needs_reingestion\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"summary": "<string>",
"error": {},
"updated_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"size": 123,
"short_summary": "<string>",
"doc_type": "<string>",
"source_metadata": {},
"content_type": "<string>",
"has_conversion": true,
"doc_metadata": {},
"name": "<string>",
"prefix": "<string>",
"uri": "<string>",
"file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dismissed": true,
"warnings": [
"<unknown>"
],
"needs_reingestion": true
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Body
application/json
Available options:
trained, training, error, uploaded, folder Show child attributes
Show child attributes
Response
Successful Response
Available options:
trained, training, error, uploaded, folder Available options:
Document, Google Drive, Notion, Website, OneDrive, Slack, Linear, Github, Teams, Sharepoint, ServiceNow, Custom ⌘I