Skip to main content
PATCH
/
v1
/
senders
/
{senderId}
/
agent
/
knowledge-bases
/
{kbId}
/
documents
/
{docId}
Update document
curl --request PATCH \
  --url https://api.zavu.dev/v1/senders/{senderId}/agent/knowledge-bases/{kbId}/documents/{docId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "content": "<string>"
}
'
import requests

url = "https://api.zavu.dev/v1/senders/{senderId}/agent/knowledge-bases/{kbId}/documents/{docId}"

payload = {
"title": "<string>",
"content": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({title: '<string>', content: '<string>'})
};

fetch('https://api.zavu.dev/v1/senders/{senderId}/agent/knowledge-bases/{kbId}/documents/{docId}', 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.zavu.dev/v1/senders/{senderId}/agent/knowledge-bases/{kbId}/documents/{docId}",
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([
'title' => '<string>',
'content' => '<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.zavu.dev/v1/senders/{senderId}/agent/knowledge-bases/{kbId}/documents/{docId}"

payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"content\": \"<string>\"\n}")

req, _ := http.NewRequest("PATCH", 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.patch("https://api.zavu.dev/v1/senders/{senderId}/agent/knowledge-bases/{kbId}/documents/{docId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"content\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.zavu.dev/v1/senders/{senderId}/agent/knowledge-bases/{kbId}/documents/{docId}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"content\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "document": {
    "id": "<string>",
    "knowledgeBaseId": "<string>",
    "title": "<string>",
    "contentLength": 123,
    "chunkCount": 123,
    "isProcessed": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
{
"code": "invalid_request",
"message": "Phone number is invalid",
"details": {}
}
{
"code": "invalid_request",
"message": "Phone number is invalid",
"details": {}
}
{
"code": "invalid_request",
"message": "Phone number is invalid",
"details": {}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

senderId
string
required
kbId
string
required
docId
string
required

Body

application/json

Fields to update on a knowledge base document. Updating content reprocesses the document for RAG.

title
string
Maximum string length: 200
content
string
Maximum string length: 500000

Response

Document updated.

document
object
required