List Archives

Get a list of all archives for the current organization with optional filters and pagination.

beforestring nullable

Archive ID cursor for pagination. Returns archives that come before this archive ID in the specified sort order

afterstring nullable

Archive ID cursor for pagination. Returns archives that come after this archive ID in the specified sort order

limitinteger nullable

Maximum number of archives to return

order'asc' | 'desc'

Sort order for archives by creation time. 'asc' for oldest first, 'desc' for newest first

namestring nullable

Filter by archive name (exact match)

agent_idstring nullable

Only archives attached to this agent ID

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

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