Skip to main content

Update document

PATCH 
/v1/default/banks/:bank_id/documents/:document_id

Update mutable fields on a document without re-processing its content.

Tags (tags): The array REPLACES the document's tags, it is not merged into them — send the complete set you want the document to end up with, and any tag you leave out is dropped. An empty array ([]) therefore clears every tag; only omitting the field entirely is rejected (422).

The new tags are propagated to all associated memory units.

Observation scopes (observation_scopes): Replaces how the document's memories are scoped during consolidation, with the same values retain accepts. Use it to move a bank whose documents were retained under per-session tags to shared without re-extracting anything. It is also what a later reprocess of the document retains with.

A memory is re-consolidated only when the change moves the observation scopes it resolves to: its observations are deleted and it is queued again, along with co-source memories from other documents that shared those observations. A change that resolves to the same scopes (a tag change under shared, combined over one tag vs [[that tag]], re-sending the current values) keeps every observation and queues nothing.

At least one field must be provided.

Authentication required — include an Authorization: Bearer hsk_... header. See Authentication for details.

Request​

Responses​

Successful Response