Skip to main content
POST
/
v1
/
sections
Create Section Handler
curl --request POST \
  --url http://localhost:8000/v1/sections \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "parent_path_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "page_number": 123,
  "prev_sibling_path_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "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",
  "page_number": 123,
  "prev_sibling_path_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "next_sibling_path_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "system_metadata": {
    "information_statistics": {
      "num_chunks_by_type": {},
      "total_tokens": 0,
      "num_direct_children": 0,
      "children_depth": 0
    }
  }
}

Headers

​
authorization
string | null

Cookies

​
ks_uat
string | null

Body

application/json

Request to create a new section.

​
name
string
required

Section name (can contain any characters)

Required string length: 1 - 255
​
parent_path_id
string<uuid>
required

Parent PathPart ID (must be DOCUMENT_VERSION or SECTION)

​
page_number
integer | null

Page number in source document (must be > 0)

​
prev_sibling_path_id
string<uuid> | null

PathPart ID to insert after (null = append to tail)

Response

Successful Response

Section response model.

​
id
string<uuid>
required

Section ID

​
path_part_id
string<uuid>
required

PathPart ID

​
name
string
required

Section name

​
parent_path_id
string<uuid>
required

Parent PathPart ID

​
materialized_path
string
required

Full materialized path from root

​
system_managed
boolean
required

Whether this section 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

​
page_number
integer | null

Page number in source document

​
prev_sibling_path_id
string<uuid> | null

Previous sibling PathPart ID

​
next_sibling_path_id
string<uuid> | null

Next sibling PathPart ID

​
system_metadata
SectionSystemMetadata · object

System-managed metadata (statistics, etc.)