Update Chunk

Update a chunk's content or metadata. Args: chunk_id: ID of the chunk to update request: UpdateChunkRequest with fields to update Returns: ChunkResponse with updated chunk Examples: Update chunk content: PATCH /chunks/chunk_123 { "content": "Updated chunk text" } Update chunk metadata: PATCH /chunks/chunk_123 { "metadata": { "category": "important", "tags": ["updated"] } } Update both content and metadata: PATCH /chunks/chunk_123 { "content": "Updated text", "metadata": {"status": "reviewed"} } Note: Updating chunk content will regenerate the embedding vector.

PATCH /api/v1/chunks/{chunk_id}

Update Chunk

cURL

curl --request PATCH \
  --url https://api.example.com/api/v1/chunks/{chunk_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "<string>",
  "metadata": {}
}
'

import requests

url = "https://api.example.com/api/v1/chunks/{chunk_id}"

payload = {
    "content": "<string>",
    "metadata": {}
}
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({content: '<string>', metadata: {}})
};

fetch('https://api.example.com/api/v1/chunks/{chunk_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/api/v1/chunks/{chunk_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([
    'content' => '<string>',
    'metadata' => [
        
    ]
  ]),
  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.example.com/api/v1/chunks/{chunk_id}"

	payload := strings.NewReader("{\n  \"content\": \"<string>\",\n  \"metadata\": {}\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.example.com/api/v1/chunks/{chunk_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"content\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/chunks/{chunk_id}")

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  \"content\": \"<string>\",\n  \"metadata\": {}\n}"

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

200

{
  "id": "<string>",
  "content_id": "<string>",
  "collection_id": "<string>",
  "content": "<string>",
  "metadata": {},
  "chunk_index": 123,
  "size": 123,
  "created_at": 123
}

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

Authorizations

Authorization · string · header · required

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

Headers

X-Workspace-Id · string | null

The workspace ID

Path Parameters

chunk_id · string · required

Chunk ID

Body

application/json

Request to update a chunk.

content · string | null

Updated chunk content

metadata · Metadata · object | null

Updated metadata

Response

200

application/json

Successful Response

Response model for a single chunk.

id · string · required

Unique chunk ID

content_id · string · required

Parent content ID

collection_id · string · required

Collection ID

content · string · required

Chunk text content

metadata · Metadata · object

Chunk metadata

chunk_index · integer | null

Index of this chunk within the document

size · integer | null

Size of chunk in bytes

created_at · integer | null

Creation timestamp