Sign in

v2

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-272589173.5 KB
Memories

List engrams

Returns a paginated list of engrams the authenticated user has access to.

Results can be filtered by providing specific engram IDs or collection IDs. Regular users will only see engrams they own or have access to through collections. Superusers can see all engrams.

The engrams are returned in order of last modification, with most recent first. The response includes the engram's text field if available.

get/v1/memories

Query parameters

idsstring[]

A list of engram IDs to retrieve. If not provided, all engrams will be returned.

A list of engram IDs to retrieve. If not provided, all engrams will be returned.

offsetinteger

Specifies the number of objects to skip. Defaults to 0.

Specifies the number of objects to skip. Defaults to 0.

limitinteger

Specifies a limit on the number of objects to return, ranging between 1 and 100. Defaults to 100.

Specifies a limit on the number of objects to return, ranging between 1 and 100. Defaults to 100.

chunks_limitinteger nullable

Maximum chunks to inline per engram. Defaults to all chunks for backwards compatibility; pass 0 to skip chunk hydration.

Maximum chunks to inline per engram. Defaults to all chunks for backwards compatibility; pass 0 to skip chunk hydration.

owner_onlyboolean

If true, only returns engrams owned by the user, not all accessible engrams.

If true, only returns engrams owned by the user, not all accessible engrams.

collection_idsstring[] nullable

Optional list of collection IDs to filter engrams by. If provided, exactly one collection ID must be specified.

Optional list of collection IDs to filter engrams by. If provided, exactly one collection ID must be specified.

metadata_filtersstring nullable

JSON string for metadata filtering. Example: '{"metadata.source": {"$eq": "playground"}}'

JSON string for metadata filtering. Example: '{"metadata.source": {"$eq": "playground"}}'

Response

Successful Response

total_entriesinteger required

Example response

{
  "results": [
    {
      "collection_ids": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "created_at": "2021-01-01T00:00:00",
      "document_type": "pdf",
      "engram_type": "document",
      "extraction_status": "pending",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "ingestion_attempt_number": 0,
      "ingestion_status": "pending",
      "metadata": {
        "title": "Sample Document"
      },
      "owner_id": "123e4567-e89b-12d3-a456-426614174000",
      "size_in_bytes": 123456,
      "title": "Sample Document",
      "total_tokens": 1000,
      "updated_at": "2021-01-01T00:00:00",
      "version": "1.0"
    }
  ]
}