Quick Start
Response Schema
The endpoint returns a structured response containing your memories and pagination information:Memory Object Fields
Core Fields
Core Fields
Field | Type | Description |
---|---|---|
id | string | Unique identifier for the memory |
status | ProcessingStatus | Current processing status (queued , extracting , chunking , embedding , indexing , done , failed ) |
type | MemoryType | Content type (text , pdf , webpage , video , image , etc.) |
title | string | null | Auto-generated or custom title |
summary | string | null | AI-generated summary of content |
createdAt | string | ISO 8601 creation timestamp |
updatedAt | string | ISO 8601 last update timestamp |
Optional Fields
Optional Fields
Field | Type | Description |
---|---|---|
customId | string | null | Your custom identifier for the memory |
connectionId | string | null | ID of connector that created this memory |
metadata | object | null | Custom key-value metadata you provided |
containerTags | string[] | Tags for organizing and filtering memories |
Key Parameters
All parameters are optional and sent in the request body since this endpoint usesPOST
:
Number of items per page. Controls how many memories are returned in a single request. Maximum recommended: 200 for optimal performance.
Page number to fetch (1-indexed). Use with
limit
to paginate through large result sets.Filter by tags. Memories must match ALL provided tags. Use for filtering by user ID, project, or custom organization tags.
Sort field. Options:
"createdAt"
(when memory was added) or "updatedAt"
(when memory was last modified).Sort direction. Use
"desc"
for newest first, "asc"
for oldest first.Advanced filtering. Filter based on metadata with advanced SQL logic.
Examples
Basic Listing
Simple memory retrieval with default settings
Filtering
Filter by tags, status, and other criteria
Pagination
Handle large datasets with pagination
Status Monitoring
Track processing status across memories
The
/v3/documents/list
endpoint uses POST method, not GET. This allows for complex filtering parameters in the request body.