API ReferenceDocumentsChunksChunk Metadata

Update Chunk Metadata

Merge updates into the custom metadata object attached to a chunk.

Path parameters

collection_namestringRequired
chunk_idstringRequired

Request

This endpoint expects an object.
custom_metadatamap from strings to anyOptional
The custom metadata object. Keys that Captain uses for its own chunk attributes are reserved and rejected with 400.
metadatamap from strings to anyOptionalDeprecated

Deprecated alias for custom_metadata.

Response

Update Chunk Metadata response.
chunk_idstring
custom_metadatamap from strings to anyOptional
The stored custom metadata object.
updated_atstring or nullOptional
filterablebooleanOptionalDefaults to false
True when the metadata also reached the search index, so query filters can match it. False when the metadata is stored but filters may not match it yet.
metadatamap from strings to anyOptionalDeprecated

Deprecated alias for custom_metadata; carries the same object.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
© 2026 Captain