Skip to content
AugentaDocsOpen console ↗
The Engram object

Documentation

API reference
View Markdown

The Engram object

A group of related claims, with a summary.

An Engram groups related Claims so your application can read a summary and inspect the statements behind it. For example, Claims about owner approval and rollback preparation can form an Engram about deployment rules. Augenta creates these groups when it processes your source.

One-shot Consolidate returns Engrams in its result; they exist only there and cannot be retrieved later. A Workspace's Engrams form in the background and are read with the operations below, by id. See Engram IDs for lookup and continuity examples.

claims is included on detail reads and one-shot completed results. List reads load it when requested with include=claims. It is a paginated collection: claimCount describes all current claims, while claims.data contains only the loaded page. Recall returns separate model-context blocks.

Available operations

Usage and lifecycle →

The Engram object

Attributes

These are response fields. “Always present” can still allow null; “conditional” means the field can be omitted.

objectstringalways present

The resource type. Always engram. Use this field to recognize Engram objects in API results.

Allowed: "engram"

idstringalways present

The ID Augenta assigns to this Engram, starting with eng_. In a Workspace, put this value in GET /v1/engrams/{id} to retrieve it. A one-shot Engram exists only in that result and has no standalone lookup URL. See Engram IDs for examples and how IDs behave as memory changes.

summarystring | nullconditional

A readable summary of the Claims grouped in this Engram. Use it to display what the Engram is about. It can change as Claims or summary text change. Null when no summary is available; omitted when summaries:false is requested.

labelstring | nullconditional

A short topic label, such as releases · rollback, for display in lists. Augenta chooses terms that distinguish this Engram from others in the same Workspace or one-shot result. An empty string means no terms qualified; null means a label is unavailable. Omitted with summaries:false.

labelSupportnumber | nullconditional

How widely the label's terms appear in this Engram's Claims. For each term, Augenta calculates the share of Claims containing it, then averages those shares. Ranges from 0 to 1: at 1, every label term appears in every Claim. It is not confidence in the label's accuracy. Null when unavailable; omitted with summaries:false.

Minimum: 0Maximum: 1

memoryClassstring | nullalways present

The kind of content Augenta identified. Common values are semantic for facts, episodic for past events, procedural for how-to knowledge and prospective for commitments or future tasks. This does not select one-shot or Workspace mode. Null when unavailable.

statusstring | nullalways present

The Engram's recorded state. weakened means its strength fell below half its recorded peak; it can return to active when its strength recovers. This describes retained memory, not Experience processing progress. Null when unavailable.

Allowed: "active""weakened"null

strengthnumber | nullalways present

A score describing the structural support for this Engram's group of Claims. Larger values indicate a stronger grouping under the memory process's scoring rules; this is not a probability or a measure of factual correctness. One-shot scores describe its last rebuild; Workspace scores come from its persisted memory history. Compare within the same memory, not across modes. Null when unavailable.

heatSharenumber | nullalways present

A relative activity measure: this Engram's share of the memory's recorded activity signal, called heat. Ranges from 0 to 1; 0.25 means one quarter of that memory's heat at the last evaluation. Workspace heat reflects incoming Claims and recorded recall activity; one-shot heat has no recorded recall activity. This is not confidence or billing usage. Null when unavailable.

Minimum: 0Maximum: 1

claimCountintegeralways present

The total number of Claims currently in this Engram. Use it to show the size of the group. It can exceed claims.data.length because only one page may be loaded; Claims that have left the Engram are excluded.

Minimum: 0

claimTokenCountinteger | nullalways present

The total number of text tokens in this Engram's current Claims, excluding its summary. It describes content size, not tokens billed for a request or the size of your eventual model prompt. Null when unavailable.

Minimum: 0

bornAtstring | nullalways present

When this Engram ID was first published, as an ISO-8601 timestamp. It is not the date of the oldest source Claim. Null when the publication time is unknown for older memory.

updatedAtstring | nullalways present

When the Engram's Claim membership or summary text last changed, as an ISO-8601 timestamp. A summary written after consolidation can advance it. Reads and changes only to scores, status or labels do not. It is not a version for the entire object. Null when the content-change time is unknown.

claimsobjectconditional

A page of Claims currently in this Engram. Read claims.data for the statements and follow claims.nextPageUrl for more. Workspace detail and completed-memory results load an initial page by default; list requests need include=claims. An omitted field means Claims were not loaded, not that the Engram is empty.

Show nested fields
objectstringalways present

The collection type. Always list.

Allowed: "list"

dataarrayalways present

Claims loaded on this page. A short or empty page can still have a continuation.

Show item fields
objectstringalways present

The resource type. Always claim.

Allowed: "claim"

idstringalways present

The ID Augenta assigns to this statement, starting with clm_. Use it to match a Claim in extractedClaims.data with the same Claim in an Engram's claims.data. It belongs to the Workspace or one-shot result that returned it.

textstringalways present

The statement extracted from your source, such as Production releases require owner approval. Read this field for the Claim's content. Claims do not have labels.

experiencestring | nullalways present

The id of the Experience this Claim came from. In Workspace mode, use it with GET /v1/experiences/{id} to check processing status. Null means the source could not be identified for an older Claim.

atstringalways present

When this statement was observed in its source, as an ISO-8601 timestamp. This is not the time you fetched the Claim.

sourceobjectconditional

Additional source details, such as a conversation session or document path, when available. The fields depend on how the source was submitted. Omitted when no source details are available.

nextPageUrlstring | nullalways present

Follow this relative URL unchanged. Null means there is no next page. One-shot output can still omit items when truncated is true.

urlstringconditional

The collection's resource path, when available. Use nextPageUrl, rather than this path, to load the next page.

truncatedbooleanconditional

True when a bounded one-shot result omitted items. One-shot results have no browsing continuation; use Workspace-backed memory when you need subsequent retrieval. False means all selected items were returned. Workspace lists use nextPageUrl instead.

billingobjectconditional

Present when billing is enabled. USD amount is exact. Receipt references settle only on successful server delivery; retries reuse the original debit.

Show nested fields
operationIdstringalways present
priceVersionstringalways present
sourceTokensintegeralways present

Minimum: 0

memoryTokensintegeralways present

Minimum: 0

measuredMemoryTokensintegeralways present

Minimum: 0

replayedbooleanalways present
complimentarybooleanconditional
ratedAmountstringconditional
amountstringalways present
receiptIdsarrayalways present
Show item fields