Skip to main content
PATCH
/
v1
/
chunks
/
{chunk_id}
Update Chunk Metadata Handler
curl --request PATCH \
  --url http://localhost:8000/v1/chunks/{chunk_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "chunk_metadata": {
    "polygons": [
      {
        "page": 123,
        "polygon": {
          "x": 123,
          "y": 123,
          "width": 123,
          "height": 123
        }
      }
    ],
    "s3_urls": [
      "<string>"
    ],
    "summary": "<string>",
    "extracted_text_s3_uri": "<string>",
    "secondary_taxonomy": "picture",
    "sheet_name": "<string>",
    "block_type": "<string>",
    "source_uri": "<string>",
    "enriched_html": "<string>",
    "cell_range": "<string>",
    "dependency_summary": {},
    "formulas": [
      {}
    ],
    "key_cells": [
      {}
    ],
    "named_ranges": [
      {}
    ]
  },
  "parent_path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prev_sibling_path_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "move_to_head": false
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "content_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "content": "<string>",
  "chunk_type": "TEXT",
  "chunk_metadata": {
    "polygons": [
      {
        "page": 123,
        "polygon": {
          "x": 123,
          "y": 123,
          "width": 123,
          "height": 123
        }
      }
    ],
    "s3_urls": [
      "<string>"
    ],
    "summary": "<string>",
    "extracted_text_s3_uri": "<string>",
    "secondary_taxonomy": "picture",
    "sheet_name": "<string>",
    "block_type": "<string>",
    "source_uri": "<string>",
    "enriched_html": "<string>",
    "cell_range": "<string>",
    "dependency_summary": {},
    "formulas": [
      {}
    ],
    "key_cells": [
      {}
    ],
    "named_ranges": [
      {}
    ]
  },
  "parent_path_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "materialized_path": "<string>",
  "system_managed": true,
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "num_tokens": 123,
  "prev_sibling_path_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "next_sibling_path_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "asset_s3_urls": [
    "<string>"
  ],
  "document": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "document_type": "PDF",
    "document_origin": "SOURCE"
  },
  "document_version": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version": 123,
    "name": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.knowledgestack.ai/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
authorization
string | null

Path Parameters

​
chunk_id
string<uuid>
required

Cookies

​
ks_uat
string | null

Body

application/json

Request to update chunk metadata and/or move the chunk.

​
chunk_metadata
ChunkMetadata · object

Metadata to merge into existing chunk_metadata (optional)

​
parent_path_part_id
string<uuid> | null

Reparent to this PathPart ID (must be DOCUMENT_VERSION or SECTION in the same document version)

​
prev_sibling_path_id
string<uuid> | null

Move after this sibling PathPart ID (within new or current parent)

​
move_to_head
boolean
default:false

Set to true to move to head of sibling list

Response

Successful Response

Chunk response model.

​
id
string<uuid>
required

Chunk ID

​
path_part_id
string<uuid>
required

PathPart ID

​
content_id
string<uuid>
required

ChunkContent ID

​
content
string
required

Chunk text content

​
chunk_type
enum<string>
required

Type of chunk content

Available options:
TEXT,
TABLE,
IMAGE,
HTML,
UNKNOWN
​
chunk_metadata
ChunkMetadata · object
required

Chunk metadata

​
parent_path_id
string<uuid>
required

Parent PathPart ID

​
materialized_path
string
required

Full materialized path from root

​
system_managed
boolean
required

Whether this chunk is system-managed

​
tenant_id
string<uuid>
required

Tenant ID

​
created_at
string<date-time>
required

Creation timestamp

​
updated_at
string<date-time>
required

Last update timestamp

​
num_tokens
integer | null

Number of tokens in chunk content

​
prev_sibling_path_id
string<uuid> | null

Previous sibling PathPart ID

​
next_sibling_path_id
string<uuid> | null

Next sibling PathPart ID

​
asset_s3_urls
string[]

Presigned URLs to download the chunk's visual assets (6-hour validity)

​
document
ChunkDocumentResponse · object

Ancestor document info (populated when with_document=true)

​
document_version
ChunkDocumentVersionResponse · object

Ancestor document version info (populated when with_document=true)