List documents

client.documents.list(, ?): DocumentListResponse { memories, pagination }

POST/v3/documents/list

Retrieves a paginated list of documents with their metadata and workflow status

ParametersExpand Collapse

body: DocumentListParams { containerTags, filepath, filters, 5 more }

DeprecatedcontainerTags?: Array<string>

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.

filepath?: string

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.

One of the following:

Or { OR }

OR: Array<FilterCondition { key, value, filterType, 3 more } | Or { OR } | And { AND } >

Array of OR filter expressions

One of the following:

FilterCondition { key, value, filterType, 3 more }

A single filter condition based on metadata, numeric values, array contents, or string matching

key: string

value: string

filterType?: "metadata" | "numeric" | "array_contains" | "string_contains"

One of the following:

"metadata"

"numeric"

"array_contains"

"string_contains"

ignoreCase?: boolean | "true" | "false"

One of the following:

boolean

"true" | "false"

"true"

"false"

negate?: boolean | "true" | "false"

One of the following:

boolean

"true" | "false"

"true"

"false"

numericOperator?: ">" | "<" | ">=" | 2 more

One of the following:

">"

"<"

">="

"<="

"="

Or { OR }

OR: Array<unknown>

OR: Array of conditions or nested expressions

And { AND }

AND: Array<unknown>

AND: Array of conditions or nested expressions

And { AND }

AND: Array<FilterCondition { key, value, filterType, 3 more } | Or { OR } | And { AND } >

Array of AND filter expressions

One of the following:

FilterCondition { key, value, filterType, 3 more }

A single filter condition based on metadata, numeric values, array contents, or string matching

key: string

value: string

filterType?: "metadata" | "numeric" | "array_contains" | "string_contains"

One of the following:

"metadata"

"numeric"

"array_contains"

"string_contains"

ignoreCase?: boolean | "true" | "false"

One of the following:

boolean

"true" | "false"

"true"

"false"

negate?: boolean | "true" | "false"

One of the following:

boolean

"true" | "false"

"true"

"false"

numericOperator?: ">" | "<" | ">=" | 2 more

One of the following:

">"

"<"

">="

"<="

"="

Or { OR }

OR: Array<unknown>

OR: Array of conditions or nested expressions

And { AND }

AND: Array<unknown>

AND: Array of conditions or nested expressions

includeContent?: boolean

Whether to include the content field in the response. Warning: This can make responses significantly larger.

limit?: string | number

Number of items per page

One of the following:

string

number

order?: "asc" | "desc"

Sort order

One of the following:

"asc"

"desc"

page?: string | number

Page number to fetch

One of the following:

string

number

sort?: "createdAt" | "updatedAt"

Field to sort by

One of the following:

"createdAt"

"updatedAt"

ReturnsExpand Collapse

DocumentListResponse { memories, pagination }

List of documents

memories: Array<Memory>

id: string

Unique identifier of the document.

minLength22

maxLength22

connectionId: string | null

Optional ID of connection the document was created from. This is useful for identifying the source of the document.

minLength22

maxLength22

createdAt: string

Creation timestamp

formatdatetime

customId: string | null

Optional custom ID of the document. This could be an ID from your database that will uniquely identify this document.

maxLength255

filepath: string | null

metadata: string | number | boolean | 2 more | null

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.

One of the following:

string

number

boolean

Record<string, unknown>

Array<unknown>

status: "unknown" | "queued" | "extracting" | 5 more

Status of the document

One of the following:

"unknown"

"queued"

"extracting"

"chunking"

"embedding"

"indexing"

"done"

"failed"

summary: string | null

Summary of the document content

title: string | null

Title of the document

type: "text" | "pdf" | "tweet" | 11 more

Type of the document

One of the following:

"text"

"pdf"

"tweet"

"google_doc"

"google_slide"

"google_sheet"

"image"

"video"

"audio"

"notion_doc"

"webpage"

"onedrive"

"github_markdown"

"granola"

updatedAt: string

Last update timestamp

formatdatetime

DeprecatedcontainerTags?: Array<string>

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.

content?: string

Content of the document (only included when includeContent=true)

url?: string | null

URL of the document

pagination: Pagination { currentPage, totalItems, totalPages, limit }

Pagination metadata

currentPage: number

totalItems: number

totalPages: number

limit?: number

maximum1100

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
  }
}