Memories

Retrieve an engram

Retrieves detailed information about a specific engram by its ID.

This endpoint returns the engram's metadata, status, and system information. It does not return the engram's content - use the /engrams/{id}/download endpoint for that.

Users can only retrieve engrams they own or have access to through collections. Superusers can retrieve any engram.

get/v1/memories/{id}

Path parameters

idstring uuid required

The ID of the engram to retrieve.

The ID of the engram to retrieve.

Response

Successful Response

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.329

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

      response-property-became-optional

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

      response-property-became-optional

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

      response-property-list-of-types-widened

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

      response-optional-property-removed

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

      response-optional-property-removed

    • api operation id get_engram_v1_memories__id__get removed and replaced with retrieve_memory

      api-operation-id-removed

    • api tag Memories added

      api-tag-added

    • 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/merkle_root to the response with the 200 status

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-property-enum-value-removed

    • removed the enriching enum value from the results/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