RUruncaptain
file-search

Patch Document Metadata V3

Changed on

Merge keys into a document's custom_metadata without restating the whole object; a null value deletes its key. Use PUT instead to replace the stored object wholesale.

patch/v3/collections/{collection_name}/documents/{document_id}/metadata

Request

  • Base URL
    https://api.captain.dev
  • URL
    https://api.captain.dev/v3/collections/{collection_name}/documents/{document_id}/metadata
  • Auth
    none declared

Path parameters

collection_namestring required
document_idstring required

Request body

custom_metadataobject

The custom metadata object. Keys that Captain uses for its own chunk attributes are reserved and rejected with 400.

metadataobject

Deprecated alias for custom_metadata.

Response

Update Document Metadata response.

custom_metadataobject
document_idstring required
filterableboolean
updated_atstring nullable

Changes

  • cce532822415Revision changes
    • info

      added the new optional request property

    • info

      request property deprecated

  • d07ce3783494Revision changes
    • info

      api operation id patch-document-metadata-v-3 removed and replaced with fileSearch_patch_document_metadata_v3