API Reference

Documents

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List documents

POST/v3/documents/list

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

Body ParametersJSONExpand Collapse

DeprecatedcontainerTags: optional array of 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: optional string

Filter documents by filepath. Exact match for full paths, prefix match if ending with /

filters: optional object { OR } or object { AND }

Optional filters to apply to the search. Can be a JSON string or Query object.

One of the following:

Or object { OR }

OR: array of object { key, value, filterType, 3 more } or object { OR } or object { AND }

Array of OR filter expressions

One of the following:

FilterCondition object { key, value, filterType, 3 more }

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

key: string

value: string

filterType: optional "metadata" or "numeric" or "array_contains" or "string_contains"

One of the following:

"metadata"

"numeric"

"array_contains"

"string_contains"

ignoreCase: optional boolean or "true" or "false"

One of the following:

boolean

"true" or "false"

One of the following:

"true"

"false"

negate: optional boolean or "true" or "false"

One of the following:

boolean

"true" or "false"

One of the following:

"true"

"false"

numericOperator: optional ">" or "<" or ">=" or 2 more

One of the following:

">"

"<"

">="

"<="

"="

Or object { OR }

OR: array of unknown

OR: Array of conditions or nested expressions

And object { AND }

AND: array of unknown

AND: Array of conditions or nested expressions

And object { AND }

AND: array of object { key, value, filterType, 3 more } or object { OR } or object { AND }

Array of AND filter expressions

One of the following:

FilterCondition object { key, value, filterType, 3 more }

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

key: string

value: string

filterType: optional "metadata" or "numeric" or "array_contains" or "string_contains"

One of the following:

"metadata"

"numeric"

"array_contains"

"string_contains"

ignoreCase: optional boolean or "true" or "false"

One of the following:

boolean

"true" or "false"

One of the following:

"true"

"false"

negate: optional boolean or "true" or "false"

One of the following:

boolean

"true" or "false"

One of the following:

"true"

"false"

numericOperator: optional ">" or "<" or ">=" or 2 more

One of the following:

">"

"<"

">="

"<="

"="

Or object { OR }

OR: array of unknown

OR: Array of conditions or nested expressions

And object { AND }

AND: array of unknown

AND: Array of conditions or nested expressions

includeContent: optional boolean

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

limit: optional string or number

Number of items per page

One of the following:

string

number

order: optional "asc" or "desc"

Sort order

One of the following:

"asc"

"desc"

page: optional string or number

Page number to fetch

One of the following:

string

number

sort: optional "createdAt" or "updatedAt"

Field to sort by

One of the following:

"createdAt"

"updatedAt"

ReturnsExpand Collapse

memories: array of object { id, connectionId, createdAt, 11 more }

id: string

Unique identifier of the document.

minLength22

maxLength22

connectionId: string

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

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

maxLength255

filepath: string

metadata: string or number or boolean or 2 more

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

map[unknown]

array of unknown

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

Status of the document

One of the following:

"unknown"

"queued"

"extracting"

"chunking"

"embedding"

"indexing"

"done"

"failed"

summary: string

Summary of the document content

title: string

Title of the document

type: "text" or "pdf" or "tweet" or 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: optional array of 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: optional string

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

url: optional string

URL of the document

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

Pagination metadata

currentPage: number

totalItems: number

totalPages: number

limit: optional number

maximum1100

List documents

HTTP

HTTP

TypeScript

Python

curl https://api.supermemory.ai/v3/documents/list \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $SUPERMEMORY_API_KEY" \
    -d '{
          "limit": 10,
          "order": "desc",
          "page": 1,
          "sort": "createdAt"
        }'

200 example

{
  "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

200 example

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