Sign in

v16

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-032765158.3 KB
Documents

Update Document

Updates a document. This endpoint is atomic.

Currently both metadata and index_status are supported.

  • When updating with a non-null metadata, the document must have index_status of indexed. After this call, the document will have an index_status of not_indexed, since the document will need to reindex with the new metadata.
  • When updating with a non-null index_status, setting it to not_parsed or not_indexed requires that the document must have index_status of parsing_failed or indexing_failed, respectively.

A 404 Not Found status code will be returned, if the provided collection name or document path does not exist.

post/documents/update-document

Request body

collection_namestring required

The name of the collection.

pathstring required

The filepath of the document that you are updating. A 404 Not Found status code will be returned if no document with this path was found.

metadataDocumentMetadataJson
index_status'not_parsed' | 'not_indexed' nullable

If the document is in the index_status of parsing_failed or indexing_failed, then this endpoint allows you to update the index status to not_parsedandnot_indexed`, respectively. This allows the document to re-attempt to parse/index after failure.

Response

Successful Response

messagestring

This string will always be "Success!". This may change in the future.