Skip to main content
POST

Authorizations

Authorization
string
header
required

Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '

Path Parameters

id
string<uuid>
required

ID of the knowledge base item.

Example:

"d949f13f-40d2-4e48-ac86-b66633070603"

Body

application/json
chunkingConfig
object

Chunking settings. Omitted values use the defaults. When a method can't be applied, the text is split by BY_PARAGRAPH instead (for example QA_PAIRS with no questions found, or BY_PAGE for text without pages). Values out of range or that contradict each other are refused with 400, never adjusted; when targetTokens is left out, the rules use 400.

maxChars
integer
default:20000

How many characters from the start of the text to preview (1,000-20,000).

Required range: 1000 <= x <= 20000
Example:

20000

Response

Successful response

success
boolean
Example:

true

message
string
Example:

"Chunks preview generated successfully!"

messageKey
string
Example:

"ChunksPreviewGenerated"

data
object