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.
Query parameters
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.
Specifies the number of objects to skip. Defaults to 0.
Specifies the number of objects to skip. Defaults to 0.
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.
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.
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.
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.
JSON string for metadata filtering. Example: '{"metadata.source": {"$eq": "playground"}}'
JSON string for metadata filtering. Example: '{"metadata.source": {"$eq": "playground"}}'
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.3310
- ▲
the response property
results/items/size_in_bytesbecame optional for the status200response-property-became-optional
- ▲
the response property
results/items/versionbecame optional for the status200response-property-became-optional
- ▲
response property
results/items/versionlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ●
deleted the
queryrequest parameterinclude_summary_embeddingsrequest-parameter-removed
- ●
removed the optional property
results/items/summaryfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
results/items/summary_embeddingfrom the response with the200statusresponse-optional-property-removed
- ○
api operation id
get_engrams_v1_memories_getremoved and replaced withlist_memoriesapi-operation-id-removed
- ○
api tag
Memoriesaddedapi-tag-added
- ○
added the new optional
queryrequest parameterchunks_limitnew-optional-request-parameter
- ○
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/items/merkle_rootto the response with the200statusresponse-optional-property-added
- ○
added the optional property
results/items/search_ready_seqto the response with the200statusresponse-optional-property-added
- ○
added the optional property
results/items/workflow_run_idto the response with the200statusresponse-optional-property-added
- ○
removed the
enrichedenum value from theresults/items/extraction_statusresponse property for the response status200response-property-enum-value-removed
- ○
removed the
enrichingenum value from theresults/items/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
- ▲