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

Changes

Changed in 1 of the 2 revisions of this API.3310

  • b1da2c0bb1ae3310See the full diff
    • the response property results/items/size_in_bytes became optional for the status 200

      response-property-became-optional

    • the response property results/items/version became optional for the status 200

      response-property-became-optional

    • response property results/items/version list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • deleted the query request parameter include_summary_embeddings

      request-parameter-removed

    • removed the optional property results/items/summary from the response with the 200 status

      response-optional-property-removed

    • removed the optional property results/items/summary_embedding from the response with the 200 status

      response-optional-property-removed

    • api operation id get_engrams_v1_memories_get removed and replaced with list_memories

      api-operation-id-removed

    • api tag Memories added

      api-tag-added

    • added the new optional query request parameter chunks_limit

      new-optional-request-parameter

    • added the optional property detail/items/ctx to the response with the 422 status

      response-optional-property-added

    • added the optional property detail/items/input to the response with the 422 status

      response-optional-property-added

    • added the optional property results/items/merkle_root to the response with the 200 status

      response-optional-property-added

    • added the optional property results/items/search_ready_seq to the response with the 200 status

      response-optional-property-added

    • added the optional property results/items/workflow_run_id to the response with the 200 status

      response-optional-property-added

    • removed the enriched enum value from the results/items/extraction_status response property for the response status 200

      response-property-enum-value-removed

    • removed the enriching enum value from the results/items/ingestion_status response property for the response status 200

      response-property-enum-value-removed

    This revision also has 119 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog