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.
Path parameters
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
- ▲
the response property
results/size_in_bytesbecame optional for the status200response-property-became-optional
- ▲
the response property
results/versionbecame optional for the status200response-property-became-optional
- ▲
response property
results/versionlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ●
removed the optional property
results/summaryfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
results/summary_embeddingfrom the response with the200statusresponse-optional-property-removed
- ○
api operation id
get_engram_v1_memories__id__getremoved and replaced withretrieve_memoryapi-operation-id-removed
- ○
api tag
Memoriesaddedapi-tag-added
- ○
added the optional property
detail/items/ctxto the response with the422statusresponse-optional-property-added
- ○
added the optional property
detail/items/inputto the response with the422statusresponse-optional-property-added
- ○
added the optional property
results/merkle_rootto the response with the200statusresponse-optional-property-added
- ○
added the optional property
results/search_ready_seqto the response with the200statusresponse-optional-property-added
- ○
added the optional property
results/workflow_run_idto the response with the200statusresponse-optional-property-added
- ○
removed the
enrichedenum value from theresults/extraction_statusresponse property for the response status200response-property-enum-value-removed
- ○
removed the
enrichingenum value from theresults/ingestion_statusresponse property for the response status200response-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
- ▲