Sign in

v36

latestOpenAPI 3.1.0raw.githubusercontent.com2025-10-091882241.2 MB
archives

Modify Archive

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

patch/v1/archives/{archive_id}

Path parameters

archive_idstring required

Request body

namestring nullable
descriptionstring nullable

Response

Successful Response

created_by_idstring nullable

The id of the user that made this object.

last_updated_by_idstring nullable

The id of the user that made this object.

created_atstring date-time required

The creation date of the archive

updated_atstring date-time nullable

The timestamp when the object was last updated.

namestring required

The name of the archive

descriptionstring nullable

A description of the archive

vector_db_provider'native' | 'tpuf' | 'pinecone'

Supported vector database providers for archival memory

metadataobject nullable

Additional metadata

idstring

The human-friendly ID of the Archive

Example response

{
  "id": "archive-123e4567-e89b-12d3-a456-426614174000"
}