Sign in

v4

latestOpenAPI 3.1.02026-08-01420618.8 KB
Documents

List documents

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

post/v3/documents/list

Request body

containerTagsstring[]

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.

includeContentboolean

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

order'asc' | 'desc'

Sort order

sort'createdAt' | 'updatedAt'

Field to sort by

filepathstring

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

Example request

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

Response

Successfully retrieved documents

Example response

{
  "memories": [
    {
      "id": "acxV5LHMEsG2hMSNb4umbn",
      "title": "API Rate Limiting Policy",
      "summary": "API rate limit policy: 100 req/min free, 1000 req/min pro.",
      "status": "done",
      "type": "text",
      "createdAt": "2025-04-15T09:30:00.000Z",
      "updatedAt": "2025-04-15T09:31:00.000Z"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "limit": 10,
    "totalItems": 100,
    "totalPages": 10
  }
}