Skip to main content
POST
Update Document by Text

Authorizations

Authorization
string
header
required

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Path Parameters

dataset_id
string<uuid>
required

Knowledge base ID. From List Knowledge Bases.

document_id
string<uuid>
required

Document ID. From List Documents.

Body

application/json
name
string

Document name. Required when text is provided.

text
string

Document text content.

process_rule
object

Processing rules for chunking.

doc_form
enum<string>
default:text_model

text_model for standard text chunking, hierarchical_model for parent-child chunk structure, qa_model for question-answer pair extraction.

Available options:
text_model,
hierarchical_model,
qa_model
doc_language
string
default:English

Language of the document for processing optimization.

retrieval_model
object

Controls how chunks are searched and ranked when querying this knowledge base.

Response

Document updated successfully.

document
object
batch
string

Batch ID for tracking indexing progress.