archives

Modify Archive

Update an existing archive’s name and/or description.

Path parameters

archive_idstringRequired

Headers

AuthorizationstringRequired

Header authentication of the form Bearer <token>

Request

This endpoint expects an object.
namestring or nullOptional
descriptionstring or nullOptional

Response

Successful Response
created_atstringformat: "date-time"
The creation date of the archive
namestring
The name of the archive
created_by_idstring or null
The id of the user that made this object.
last_updated_by_idstring or null
The id of the user that made this object.
updated_atstring or nullformat: "date-time"
The timestamp when the object was last updated.
descriptionstring or null
A description of the archive
vector_db_providerenum or null
The vector database provider used for this archive's passages
Allowed values:
metadatamap from strings to any or null
Additional metadata
idstring or nullformat: "^archive-[a-fA-F0-9]{8}"

The human-friendly ID of the Archive

Errors