Consolidate
/v1/consolidateExtract 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
streambooleanoptionalincludearrayoptionalWhich 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_limitintegeroptionalMaximum 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_limitintegeroptionalMaximum 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
summariesbooleanoptionalWrite 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.
sessionstringrequiredMin length: 1Max length: 256
messagesarrayrequiredMin items: 1Max items: 100000
Show item fields
rolestringrequiredAllowed: "system""developer""user""assistant""tool"
contentchoicerequiredtool_callsarrayoptionalShow item fields
idstringrequiredtypestringoptionalfunctionobjectrequiredShow nested fields
See the complete schema in the OpenAPI specification.
tool_call_idstringoptionalnamestringoptionaltsstringoptionalseqintegeroptionalMinimum: 0
One-shot · experiences
streambooleanoptionalincludearrayoptionalWhich 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_limitintegeroptionalMaximum 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_limitintegeroptionalMaximum 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
summariesbooleanoptionalWrite 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.
experiencesarrayrequiredMin items: 1Max items: 50
Show item fields
srcstringrequiredWho composed it. Send service from your own code.
Allowed: "service""claude-code""codex"
sidstringrequiredThe session id: one conversation, one agent run, or one document. Experiences that share it are one stream.
Min length: 1
projstringoptionalAn optional project name, for your own grouping. Defaults to empty.
typestringoptionaltrajectory (the default) for conversations and agent runs, doc for a document.
eventsarrayoptionalA trajectory's steps. Required for a trajectory; not allowed on other types.
Show item fields
seqintegerrequiredThe step's position in the session. Integer; give each step its own, increasing across calls.
tsstringrequiredWhen it happened: ISO-8601 with an offset.
kindstringrequiredmsg for a message; session for context such as a system prompt; tool for a tool call or result.
Allowed: "msg""tool""error""outcome""session"
rolestringrequiredAllowed: "user""assistant""tool""system"
textstringrequiredWhat was said or done. Scrub secrets before sending.
datavalueoptionalAny JSON. A document's content: {documentId, title?, text, capturedAt?, deleted?}. Optional on a trajectory, where it is kept as raw telemetry.
Workspace · messages
streambooleanoptionalclaims_limitintegeroptionalMaximum 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
includearrayoptionalShow item fields
Allowed: "extractedClaims"
querystringoptionalMin length: 1Max length: 4096
budget_tokensintegeroptionalMinimum: 1Maximum: 128000
keep_recentintegeroptionalMinimum: 0Maximum: 100000
workspacestringrequiredMin length: 1
sessionstringrequiredMin length: 1Max length: 256
messagesarrayrequiredMin items: 1Max items: 100000
Show item fields
rolestringrequiredAllowed: "system""developer""user""assistant""tool"
contentchoicerequiredtool_callsarrayoptionalShow item fields
idstringrequiredtypestringoptionalfunctionobjectrequiredShow nested fields
See the complete schema in the OpenAPI specification.
tool_call_idstringoptionalnamestringoptionaltsstringoptionalseqintegeroptionalMinimum: 0
Workspace · experiences
streambooleanoptionalclaims_limitintegeroptionalMaximum 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
includearrayoptionalShow item fields
Allowed: "extractedClaims"
querystringoptionalMin length: 1Max length: 4096
budget_tokensintegeroptionalMinimum: 1Maximum: 128000
keep_recentintegeroptionalMinimum: 0Maximum: 100000
workspacestringrequiredMin length: 1
experiencesarrayrequiredMin items: 1Max items: 50
Show item fields
srcstringrequiredWho composed it. Send service from your own code.
Allowed: "service""claude-code""codex"
sidstringrequiredThe session id: one conversation, one agent run, or one document. Experiences that share it are one stream.
Min length: 1
projstringoptionalAn optional project name, for your own grouping. Defaults to empty.
typestringoptionaltrajectory (the default) for conversations and agent runs, doc for a document.
eventsarrayoptionalA trajectory's steps. Required for a trajectory; not allowed on other types.
Show item fields
seqintegerrequiredThe step's position in the session. Integer; give each step its own, increasing across calls.
tsstringrequiredWhen it happened: ISO-8601 with an offset.
kindstringrequiredmsg for a message; session for context such as a system prompt; tool for a tool call or result.
Allowed: "msg""tool""error""outcome""session"
rolestringrequiredAllowed: "user""assistant""tool""system"
textstringrequiredWhat was said or done. Scrub secrets before sending.
datavalueoptionalAny 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
billingobjectconditionalPresent 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 presentpriceVersionstringalways presentsourceTokensintegeralways presentMinimum: 0
memoryTokensintegeralways presentMinimum: 0
measuredMemoryTokensintegeralways presentMinimum: 0
replayedbooleanalways presentcomplimentarybooleanconditionalratedAmountstringconditionalamountstringalways presentreceiptIdsarrayalways presentShow item fields
experiencesarrayalways presentShow item fields
idstringalways presentThe 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 presentAllowed: "consolidated""skipped"
billingOperationIdstringconditionalReference to this source's billing operation, when billing is enabled.
claimIdsarrayalways presentShow item fields
extractedClaimsobjectconditionalA 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
dataarrayalways presentClaims loaded on this page. A short or empty page can still have a continuation.
Show item fields
idstringalways presentThe 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 presentThe 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 presentThe 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 presentWhen this statement was observed in its source, as an ISO-8601 timestamp. This is not the time you fetched the Claim.
sourceobjectconditionalAdditional 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 presentFollow this relative URL unchanged. Null means there is no next page. One-shot output can still omit items when truncated is true.
urlstringconditionalThe collection's resource path, when available. Use nextPageUrl, rather than this path, to load the next page.
truncatedbooleanconditionalTrue 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.
billingobjectconditionalPresent 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 presentpriceVersionstringalways presentsourceTokensintegeralways presentMinimum: 0
memoryTokensintegeralways presentMinimum: 0
measuredMemoryTokensintegeralways presentMinimum: 0
replayedbooleanalways presentcomplimentarybooleanconditionalratedAmountstringconditionalamountstringalways presentreceiptIdsarrayalways presentShow item fields
extractedClaimsCompletebooleanconditionalWhether 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 presentShow nested fields
objectstringalways presentAllowed: "list"
dataarrayalways presentShow item fields
objectstringalways presentThe resource type. Always engram. Use this field to recognize Engram objects in API results.
Allowed: "engram"
idstringalways presentThe 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 | nullconditionalA 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 | nullconditionalA 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 | nullconditionalHow 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 presentThe 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 presentThe 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 presentA 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.
claimCountintegeralways presentThe 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 presentThe 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 presentWhen 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 presentWhen 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.
claimsobjectconditionalA 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
dataarrayalways presentClaims 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 presentFollow this relative URL unchanged. Null means there is no next page. One-shot output can still omit items when truncated is true.
urlstringconditionalThe collection's resource path, when available. Use nextPageUrl, rather than this path, to load the next page.
truncatedbooleanconditionalTrue 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.
billingobjectconditionalPresent 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 presenturlstringconditionaltruncatedbooleanconditionalTrue 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.
billingobjectconditionalPresent 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 presentpriceVersionstringalways presentsourceTokensintegeralways presentMinimum: 0
memoryTokensintegeralways presentMinimum: 0
measuredMemoryTokensintegeralways presentMinimum: 0
replayedbooleanalways presentcomplimentarybooleanconditionalratedAmountstringconditionalamountstringalways presentreceiptIdsarrayalways presentShow item fields
eventsarrayalways presentShow item fields
idstringalways presentThe 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 presentWhat 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 presentRecorded 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 presentThe 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 presentShow nested fields
kindstringalways presentWhat 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 presentThe 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 presentThe affected Engram's total current Claims immediately before this transition. Zero for a new Engram.
Minimum: 0
claimCountAfterintegeralways presentThe affected Engram's total current Claims immediately after this transition. Zero when the identity is retired.
Minimum: 0
intoarrayalways presentNew Engram IDs created by a split. Empty for other transition kinds.
Show item fields
See the complete schema in the OpenAPI specification.
absorbedarrayalways presentEngram 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 presentWhen this transition was recorded, as an ISO-8601 timestamp. The enclosing Event's created field represents the same time in Unix seconds.
usageobjectalways presentShow nested fields
tokensSentintegeralways presenttokensSentSourcestringconditionalmodelInputTokensintegerconditionalmodelOutputTokensintegerconditionaltimingobjectalways presentShow nested fields
firstClaimMsnumber | nullalways presentfirstEngramMsnumber | nullalways presenttotalMsnumberalways presentWorkspace · experiences
billingobjectconditionalPresent 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 presentpriceVersionstringalways presentsourceTokensintegeralways presentMinimum: 0
memoryTokensintegeralways presentMinimum: 0
measuredMemoryTokensintegeralways presentMinimum: 0
replayedbooleanalways presentcomplimentarybooleanconditionalratedAmountstringconditionalamountstringalways presentreceiptIdsarrayalways presentShow item fields
workspacestringalways presentoperationstringalways presentexperiencesarrayalways presentShow item fields
idstringalways presentThe 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 presentAllowed: "processed""superseded"
billingOperationIdstringconditionalReference to this source's billing operation, when billing is enabled.
claimIdsarrayconditionalIDs of Claims extracted from this source, when returned. Read extractedClaims.data or an Engram's claims.data for their text.
Show item fields
extractedClaimsobjectconditionalA 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
dataarrayalways presentClaims loaded on this page. A short or empty page can still have a continuation.
Show item fields
idstringalways presentThe 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 presentThe 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 presentThe 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 presentWhen this statement was observed in its source, as an ISO-8601 timestamp. This is not the time you fetched the Claim.
sourceobjectconditionalAdditional 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 presentFollow this relative URL unchanged. Null means there is no next page. One-shot output can still omit items when truncated is true.
urlstringconditionalThe collection's resource path, when available. Use nextPageUrl, rather than this path, to load the next page.
truncatedbooleanconditionalTrue 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.
billingobjectconditionalPresent 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 presentpriceVersionstringalways presentsourceTokensintegeralways presentMinimum: 0
memoryTokensintegeralways presentMinimum: 0
measuredMemoryTokensintegeralways presentMinimum: 0
replayedbooleanalways presentcomplimentarybooleanconditionalratedAmountstringconditionalamountstringalways presentreceiptIdsarrayalways presentShow item fields
extractedClaimsCompletebooleanconditionalusageobjectalways presentShow nested fields
tokensSentinteger | nullalways presenttokensSentSourcestring | nullalways presentmodelInputTokensinteger | nullalways presentmodelOutputTokensinteger | nullalways presentcontextobjectalways presentShow nested fields
memoryarrayalways presentShow item fields
messagesarrayalways presentShow item fields
rolestringalways presentAllowed: "system""developer""user""assistant""tool"
contentchoicealways presentShow 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_callsarrayconditionalShow item fields
See the complete schema in the OpenAPI specification.
tool_call_idstringconditionalnamestringconditionaltsstringconditionalseqintegerconditionalMinimum: 0
budget_tokensintegeralways presenttokensEstimatedintegeralways presenttokenEstimateSourcestringalways presentAllowed: "estimate:utf8-bytes/3.5"
memoryTruncatedbooleanalways presentrecallobjectconditionaltimingobjectalways presentShow nested fields
firstClaimMsnumber | nullalways presentfirstEngramMsnumber | nullalways presenttotalMsnumberalways present