Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Timbal API key. Obtain your API key from the Timbal platform settings. See Authentication for more information.

Path Parameters

org_id
string
required
kb_id
string
required
file_id
string
required

Body

application/json
content
string
required
after_uid
string<uuid> | null

Place the new chunk immediately after this chunk_uid. Mutually exclusive with before_uid. If neither is set, the chunk is appended at the end of the file.

before_uid
string<uuid> | null

Place the new chunk immediately before this chunk_uid. Mutually exclusive with after_uid.

embed
string | null

Text used for vector / full-text indexing. Defaults to content when omitted; provide an explicit value to keep an indexing-optimized variant distinct from the user-visible text.

page_end
integer<int32> | null
page_start
integer<int32> | null

Response

Chunk inserted

blocks
object
required

Source-document layout metadata (e.g. bounding boxes, page coords) when available. null for chunks created or edited by the user.

content
string
required
created_at
string<date-time>
required
embed
string
required
index_status
string
required

Indexing state for search (pending, indexing, indexed, or failed).

kb_file_id
string
required
ordinal
string
required

Ordering key within the file.

revision
string
required

Revision token for optimistic concurrency on update and delete.

source
string
required

Origin of the chunk: parser, user_edit, or insert.

uid
string<uuid>
required

Stable per-chunk identity.

updated_at
string<date-time>
required
index_error
string | null
indexed_at
string<date-time> | null
page_end
integer<int32> | null
page_start
integer<int32> | null