List documents
Retrieves a paginated list of documents with their metadata and workflow status
ParametersExpand Collapse
body: DocumentListParams { containerTags, filepath, filters, 5 more }
Optional tags this document should be containerized by. This can be an ID for your user, a project ID, or any other identifier you wish to use to group documents.
Filter documents by filepath. Exact match for full paths, prefix match if ending with /
filters?: Or { OR } | And { AND } Optional filters to apply to the search. Can be a JSON string or Query object.
Optional filters to apply to the search. Can be a JSON string or Query object.
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >Array of OR filter expressions
Array of OR filter expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >Array of AND filter expressions
Array of AND filter expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
OR: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >OR: Array of conditions or nested expressions
OR: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
And { AND }
AND: Array<UnionMember0 { key, value, filterType, 3 more } | Or { OR } | And { AND } >AND: Array of conditions or nested expressions
AND: Array of conditions or nested expressions
UnionMember0 { key, value, filterType, 3 more } A single filter condition based on metadata, numeric values, array contents, or string matching
A single filter condition based on metadata, numeric values, array contents, or string matching
Or { OR }
ReturnsExpand Collapse
DocumentListResponse { memories, pagination } List of documents
List of documents
memories: Array<Memory>
Optional ID of connection the document was created from. This is useful for identifying the source of the document.
Optional custom ID of the document. This could be an ID from your database that will uniquely identify this document.
metadata: string | number | boolean | 2 more | nullOptional metadata for the document. This is used to store additional information about the document. You can use this to store any additional information you need about the document. Metadata can be filtered through. Keys must be strings and are case sensitive. Values can be strings, numbers, or booleans. You cannot nest objects.
Optional metadata for the document. This is used to store additional information about the document. You can use this to store any additional information you need about the document. Metadata can be filtered through. Keys must be strings and are case sensitive. Values can be strings, numbers, or booleans. You cannot nest objects.
List documents
import Supermemory from 'supermemory';
const client = new Supermemory({
apiKey: process.env['SUPERMEMORY_API_KEY'], // This is the default and can be omitted
});
const documents = await client.documents.list();
console.log(documents.memories);{
"memories": [
{
"id": "acxV5LHMEsG2hMSNb4umbn",
"connectionId": "xxxxxxxxxxxxxxxxxxxxxx",
"createdAt": "2025-04-15T09:30:00.000Z",
"customId": "doc-api-rate-limits",
"filepath": "filepath",
"metadata": {
"source": "bar",
"language": "bar"
},
"status": "done",
"summary": "API rate limit policy: 100 req/min free, 1000 req/min pro.",
"title": "API Rate Limiting Policy",
"type": "text",
"updatedAt": "2025-04-15T09:31:00.000Z",
"containerTags": [
"string"
],
"content": "This is the content of the document...",
"url": "https://docs.example.com/guides/rate-limits"
}
],
"pagination": {
"currentPage": 1,
"totalItems": 100,
"totalPages": 10,
"limit": 10
}
}Returns Examples
{
"memories": [
{
"id": "acxV5LHMEsG2hMSNb4umbn",
"connectionId": "xxxxxxxxxxxxxxxxxxxxxx",
"createdAt": "2025-04-15T09:30:00.000Z",
"customId": "doc-api-rate-limits",
"filepath": "filepath",
"metadata": {
"source": "bar",
"language": "bar"
},
"status": "done",
"summary": "API rate limit policy: 100 req/min free, 1000 req/min pro.",
"title": "API Rate Limiting Policy",
"type": "text",
"updatedAt": "2025-04-15T09:31:00.000Z",
"containerTags": [
"string"
],
"content": "This is the content of the document...",
"url": "https://docs.example.com/guides/rate-limits"
}
],
"pagination": {
"currentPage": 1,
"totalItems": 100,
"totalPages": 10,
"limit": 10
}
}