List documents

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

POST /v3/documents/list

Try it

List documents

Javascript

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    filters: {
      AND: [
        {filterType: 'metadata', key: 'group', negate: false, value: 'jira_users'},
        {
          filterType: 'numeric',
          key: 'timestamp',
          negate: false,
          numericOperator: '>',
          value: '1742745777'
        }
      ]
    },
    limit: 10,
    order: 'desc',
    page: 1,
    sort: 'createdAt'
  })
};

fetch('https://api.supermemory.ai/v3/documents/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "memories": [
    {
      "connectionId": "conn_123",
      "containerTags": [
        "user_123"
      ],
      "createdAt": "1970-01-01T00:00:00.000Z",
      "customId": "mem_abc123",
      "id": "acxV5LHMEsG2hMSNb4umbn",
      "metadata": {
        "category": "technology",
        "isPublic": true,
        "readingTime": 5,
        "source": "web",
        "tag_1": "ai",
        "tag_2": "machine-learning"
      },
      "status": "done",
      "summary": "A comprehensive guide to understanding the basics of machine learning and its applications.",
      "title": "Introduction to Machine Learning",
      "type": "text",
      "updatedAt": "1970-01-01T00:00:00.000Z"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "limit": 10,
    "totalItems": 100,
    "totalPages": 10
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Query parameters for listing documents

containerTags · 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.

Example:

["user_123", "project_123"]

filters · object

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

Option 1

Show child attributes

filters. OR · any[] · required

includeContent · boolean · default: false

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

Example:

false

limit

Number of items per page

Example:

"10"

order · enum<string> · default: desc

Sort order

Available options: asc, desc

Example:

"desc"

page

Page number to fetch

Example:

"1"

sort · enum<string> · default: createdAt

Field to sort by

Available options: createdAt, updatedAt

Example:

"createdAt"

Response

200

application/json

Successfully retrieved documents

List of documents

memories · object[] · required

Show child attributes

memories. connectionId · string · null · null · required

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

Required string length: 22

Example:

"conn_123"

memories. createdAt · string<datetime> · required

Creation timestamp

Example:

"1970-01-01T00:00:00.000Z"

memories. customId · string | null · required

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

Maximum string length: 255

Example:

"mem_abc123"

memories. id · string · required

Unique identifier of the document.

Required string length: 22

Example:

"acxV5LHMEsG2hMSNb4umbn"

memories. metadata · required

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.

Example:

{
  "category": "technology",
  "isPublic": true,
  "readingTime": 5,
  "source": "web",
  "tag_1": "ai",
  "tag_2": "machine-learning"
}

memories. status · enum<string> · required

Status of the document

Available options: unknown, queued, extracting, chunking, embedding, indexing, done, failed

Example:

"done"

memories. summary · string | null · required

Summary of the document content

Example:

"A comprehensive guide to understanding the basics of machine learning and its applications."

memories. title · string | null · required

Title of the document

Example:

"Introduction to Machine Learning"

memories. type · enum<string> · required

Type of the document

Available options: text, pdf, tweet, google_doc, google_slide, google_sheet, image, video, notion_doc, webpage, onedrive

Example:

"text"

memories. updatedAt · string<datetime> · required

Last update timestamp

Example:

"1970-01-01T00:00:00.000Z"

memories. containerTags · 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.

Example:

["user_123", "project_123"]

memories. content · string

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

Example:

"This is the content of the document..."

pagination · object · required

Pagination metadata

Show child attributes

pagination. currentPage · number · required

pagination. totalItems · number · required

pagination. totalPages · number · required

pagination. limit · number · default: 10

Required range: x <= 1100

Example:

{
  "currentPage": 1,
  "limit": 10,
  "totalItems": 100,
  "totalPages": 10
}