archives

List Archives

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

Headers

AuthorizationstringRequired

Header authentication of the form Bearer <token>

Query parameters

beforestring or nullOptional
Archive ID cursor for pagination. Returns archives that come before this archive ID in the specified sort order
afterstring or nullOptional
Archive ID cursor for pagination. Returns archives that come after this archive ID in the specified sort order
limitinteger or nullOptionalDefaults to 50
Maximum number of archives to return
orderenumOptionalDefaults to desc
Sort order for archives by creation time. 'asc' for oldest first, 'desc' for newest first
Allowed values:
namestring or nullOptional

Filter by archive name (exact match)

agent_idstring or nullOptional
Only archives attached to this agent ID

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