Skip to content
AugentaDocsOpen console ↗
Consolidate

Documentation

API reference
View Markdown

Consolidate

POST/v1/consolidate

Extract Claims and group them into Engrams. With workspace, submit source Experiences, wait for committed Recall-ready claims and schedule background consolidation; an optional query also runs Recall. Without workspace, process only this request and return bounded results without persistence or a continuation. stream=true emits provisional claims and one authoritative completed result; one-shot mode also emits engram previews. Workspace collections have resource page URLs; one-shot collections have nextPageUrl:null and a truncated flag. No query endpoints or saved snapshots are supported.

Authentication

Send your API key with the AugentaKey authorization scheme. Workspace requests must target a Workspace assigned to the key. See authentication and permissions.

Request

Body fields

Send messages with session, or experience envelopes. Include workspace for durable processing and optional Recall/context. Omit workspace for one-shot stateless processing: no data is retained and no continuation is returned. query, budget_tokens and keep_recent apply only to Workspace mode; summaries applies only to one-shot mode.

One-shot · messages
streambooleanoptional
includearrayoptional

Which Claim collections to load in a completed-memory result. claims loads each Engram's initial Claim page; extractedClaims loads a separate page for this call's extraction. Omit this parameter for both, or send [] for neither. Asynchronous Workspace Experiences rejects output controls.

Max items: 2

Default: ["claims","extractedClaims"]

Show item fields

Allowed: "claims""extractedClaims"

claims_limitintegeroptional

Maximum Claims per initial collection page. It does not cap the Engram's total claimCount. Workspace results expose nextPageUrl for more. One-shot results report truncated when items were omitted and cannot be browsed later.

Minimum: 1Maximum: 500

Default: 100

engrams_limitintegeroptional

Maximum Engrams in the initial result page. A shared output bound can make output shorter. Follow Workspace engrams.nextPageUrl for more; one-shot results report truncated instead of a browsing URL.

Minimum: 1Maximum: 500

Default: 100

summariesbooleanoptional

Write summaries for one-shot Engrams (default true). false skips summary writing and omits summary, label and labelSupport. Workspace summaries follow its synthesis policy. Stateless output is not saved.

sessionstringrequired

Min length: 1Max length: 256

messagesarrayrequired

Min items: 1Max items: 100000

Show item fields
rolestringrequired

Allowed: "system""developer""user""assistant""tool"

contentchoicerequired
Show nested fields
string
null
array

See the complete schema in the OpenAPI specification.

tool_callsarrayoptional
Show item fields
idstringrequired
typestringoptional
functionobjectrequired
Show nested fields

See the complete schema in the OpenAPI specification.

tool_call_idstringoptional
namestringoptional
tsstringoptional
seqintegeroptional

Minimum: 0

One-shot · experiences
streambooleanoptional
includearrayoptional

Which Claim collections to load in a completed-memory result. claims loads each Engram's initial Claim page; extractedClaims loads a separate page for this call's extraction. Omit this parameter for both, or send [] for neither. Asynchronous Workspace Experiences rejects output controls.

Max items: 2

Default: ["claims","extractedClaims"]

Show item fields

Allowed: "claims""extractedClaims"

claims_limitintegeroptional

Maximum Claims per initial collection page. It does not cap the Engram's total claimCount. Workspace results expose nextPageUrl for more. One-shot results report truncated when items were omitted and cannot be browsed later.

Minimum: 1Maximum: 500

Default: 100

engrams_limitintegeroptional

Maximum Engrams in the initial result page. A shared output bound can make output shorter. Follow Workspace engrams.nextPageUrl for more; one-shot results report truncated instead of a browsing URL.

Minimum: 1Maximum: 500

Default: 100

summariesbooleanoptional

Write summaries for one-shot Engrams (default true). false skips summary writing and omits summary, label and labelSupport. Workspace summaries follow its synthesis policy. Stateless output is not saved.

experiencesarrayrequired

Min items: 1Max items: 50

Show item fields
srcstringrequired

Who composed it. Send service from your own code.

Allowed: "service""claude-code""codex"

sidstringrequired

The session id: one conversation, one agent run, or one document. Experiences that share it are one stream.

Min length: 1

projstringoptional

An optional project name, for your own grouping. Defaults to empty.

typestringoptional

trajectory (the default) for conversations and agent runs, doc for a document.

eventsarrayoptional

A trajectory's steps. Required for a trajectory; not allowed on other types.

Show item fields
seqintegerrequired

The step's position in the session. Integer; give each step its own, increasing across calls.

tsstringrequired

When it happened: ISO-8601 with an offset.

kindstringrequired

msg for a message; session for context such as a system prompt; tool for a tool call or result.

Allowed: "msg""tool""error""outcome""session"

rolestringrequired

Allowed: "user""assistant""tool""system"

textstringrequired

What was said or done. Scrub secrets before sending.

datavalueoptional

Any JSON. A document's content: {documentId, title?, text, capturedAt?, deleted?}. Optional on a trajectory, where it is kept as raw telemetry.

Workspace · messages
streambooleanoptional
claims_limitintegeroptional

Maximum Claims per initial collection page. It does not cap the Engram's total claimCount. Workspace results expose nextPageUrl for more. One-shot results report truncated when items were omitted and cannot be browsed later.

Minimum: 1Maximum: 500

Default: 100

includearrayoptional
Show item fields

Allowed: "extractedClaims"

querystringoptional

Min length: 1Max length: 4096

budget_tokensintegeroptional

Minimum: 1Maximum: 128000

keep_recentintegeroptional

Minimum: 0Maximum: 100000

workspacestringrequired

Min length: 1

sessionstringrequired

Min length: 1Max length: 256

messagesarrayrequired

Min items: 1Max items: 100000

Show item fields
rolestringrequired

Allowed: "system""developer""user""assistant""tool"

contentchoicerequired
Show nested fields
string
null
array

See the complete schema in the OpenAPI specification.

tool_callsarrayoptional
Show item fields
idstringrequired
typestringoptional
functionobjectrequired
Show nested fields

See the complete schema in the OpenAPI specification.

tool_call_idstringoptional
namestringoptional
tsstringoptional
seqintegeroptional

Minimum: 0

Workspace · experiences
streambooleanoptional
claims_limitintegeroptional

Maximum Claims per initial collection page. It does not cap the Engram's total claimCount. Workspace results expose nextPageUrl for more. One-shot results report truncated when items were omitted and cannot be browsed later.

Minimum: 1Maximum: 500

Default: 100

includearrayoptional
Show item fields

Allowed: "extractedClaims"

querystringoptional

Min length: 1Max length: 4096

budget_tokensintegeroptional

Minimum: 1Maximum: 128000

keep_recentintegeroptional

Minimum: 0Maximum: 100000

workspacestringrequired

Min length: 1

experiencesarrayrequired

Min items: 1Max items: 50

Show item fields
srcstringrequired

Who composed it. Send service from your own code.

Allowed: "service""claude-code""codex"

sidstringrequired

The session id: one conversation, one agent run, or one document. Experiences that share it are one stream.

Min length: 1

projstringoptional

An optional project name, for your own grouping. Defaults to empty.

typestringoptional

trajectory (the default) for conversations and agent runs, doc for a document.

eventsarrayoptional

A trajectory's steps. Required for a trajectory; not allowed on other types.

Show item fields
seqintegerrequired

The step's position in the session. Integer; give each step its own, increasing across calls.

tsstringrequired

When it happened: ISO-8601 with an offset.

kindstringrequired

msg for a message; session for context such as a system prompt; tool for a tool call or result.

Allowed: "msg""tool""error""outcome""session"

rolestringrequired

Allowed: "user""assistant""tool""system"

textstringrequired

What was said or done. Scrub secrets before sending.

datavalueoptional

Any JSON. A document's content: {documentId, title?, text, capturedAt?, deleted?}. Optional on a trajectory, where it is kept as raw telemetry.

Responses

JSON final result or SSE. Computation-stage first claim/engram timings exclude authentication, request parsing and progress events; null means no such item formed. Provisional engrams may be revised; completed Engrams are authoritative.

object
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
experiencesarrayalways present
Show item fields
objectstringalways present

The resource type. Always experience.

Allowed: "experience"

idstringalways present

The ID Augenta assigns to this submitted source. In Workspace mode, use it with GET /v1/experiences/{id} to check processing status. One-shot source references have no stored status URL.

statusstringalways present

Allowed: "consolidated""skipped"

billingOperationIdstringconditional

Reference to this source's billing operation, when billing is enabled.

claimIdsarrayalways present
Show item fields
extractedClaimsobjectconditional

A page of Claims from this call's source material, including Claims that did not form an Engram. A Claim can also appear in an Engram's claims.data with the same ID. Omitted when not requested.

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
extractedClaimsCompletebooleanconditional

Whether extraction coverage could be verified for the selected source material. This is not page completion: check extractedClaims.truncated for omitted output. Omitted when extractedClaims is not requested.

engramsobjectalways present
Show nested fields
objectstringalways present

Allowed: "list"

dataarrayalways present
Show item fields
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

See the complete schema in the OpenAPI specification.

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

See the complete schema in the OpenAPI specification.

nextPageUrlstring | nullalways present
urlstringconditional
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
eventsarrayalways present
Show item fields
objectstringalways present

The resource type. Always event.

Allowed: "event"

idstringalways present

The ID of this recorded Event, starting with evt_. Use it with GET /v1/events/{id} in the same Workspace. Read data.object.id for the affected Engram's eng_ ID. Snapshot Events are returned inline and have no stored lookup URL.

typestringalways present

What happened: an Engram was created, changed membership, split, merged or retired. These Events do not report every score or summary update.

Allowed: "engram.created""engram.changed""engram.split""engram.merged""engram.retired"

createdintegeralways present

Recorded event time as Unix seconds. Workspace event feeds follow committed order even when source clocks go backward; one-shot events describe the completed rebuild.

dataobjectalways present

The recorded identity-lineage payload. Completed memory results return the same Event resource in events. This is not a historical Engram snapshot or a complete score/prose audit.

Show nested fields
objectobjectalways present
Show nested fields
objectstringalways present

The recorded payload type. Always engram_change.

Allowed: "engram_change"

kindstringalways present

What happened to the affected Engram's identity or Claim membership. The enclosing Event exposes the corresponding dotted type, such as engram.created for born.

Allowed: "born""update""split""merge""retire"

idstringalways present

The ID of the Engram affected by this transition. This is an eng_ ID, not the Event's evt_ ID. The Engram may have been retired since this Event was recorded.

claimCountBeforeintegeralways present

The affected Engram's total current Claims immediately before this transition. Zero for a new Engram.

Minimum: 0

claimCountAfterintegeralways present

The affected Engram's total current Claims immediately after this transition. Zero when the identity is retired.

Minimum: 0

intoarrayalways present

New Engram IDs created by a split. Empty for other transition kinds.

Show item fields

See the complete schema in the OpenAPI specification.

absorbedarrayalways present

Engram IDs merged into this surviving Engram and retired. Empty for other transition kinds.

Show item fields

See the complete schema in the OpenAPI specification.

atstringalways present

When this transition was recorded, as an ISO-8601 timestamp. The enclosing Event's created field represents the same time in Unix seconds.

usageobjectalways present
Show nested fields
tokensSentintegeralways present
tokensSentSourcestringconditional
modelInputTokensintegerconditional
modelOutputTokensintegerconditional
timingobjectalways present
Show nested fields
firstClaimMsnumber | nullalways present
firstEngramMsnumber | nullalways present
totalMsnumberalways present
Workspace · experiences
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
workspacestringalways present
operationstringalways present
experiencesarrayalways present
Show item fields
objectstringalways present

The resource type. Always experience.

Allowed: "experience"

idstringalways present

The ID Augenta assigns to this submitted source. In Workspace mode, use it with GET /v1/experiences/{id} to check processing status. One-shot source references have no stored status URL.

statusstringalways present

Allowed: "processed""superseded"

billingOperationIdstringconditional

Reference to this source's billing operation, when billing is enabled.

claimIdsarrayconditional

IDs of Claims extracted from this source, when returned. Read extractedClaims.data or an Engram's claims.data for their text.

Show item fields
extractedClaimsobjectconditional

A page of Claims from this call's source material, including Claims that did not form an Engram. A Claim can also appear in an Engram's claims.data with the same ID. Omitted when not requested.

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
extractedClaimsCompletebooleanconditional
usageobjectalways present
Show nested fields
tokensSentinteger | nullalways present
tokensSentSourcestring | nullalways present
modelInputTokensinteger | nullalways present
modelOutputTokensinteger | nullalways present
contextobjectalways present
Show nested fields
memoryarrayalways present
Show item fields
messagesarrayalways present
Show item fields
rolestringalways present

Allowed: "system""developer""user""assistant""tool"

contentchoicealways present
Show nested fields
string

See the complete schema in the OpenAPI specification.

null

See the complete schema in the OpenAPI specification.

array

See the complete schema in the OpenAPI specification.

tool_callsarrayconditional
Show item fields

See the complete schema in the OpenAPI specification.

tool_call_idstringconditional
namestringconditional
tsstringconditional
seqintegerconditional

Minimum: 0

budget_tokensintegeralways present
tokensEstimatedintegeralways present
tokenEstimateSourcestringalways present

Allowed: "estimate:utf8-bytes/3.5"

memoryTruncatedbooleanalways present
recallobjectconditional
timingobjectalways present
Show nested fields
firstClaimMsnumber | nullalways present
firstEngramMsnumber | nullalways present
totalMsnumberalways present