Skip to content
AugentaDocsOpen console ↗
List an engram's claims

Documentation

API reference
View Markdown

List an engram's claims

Follow the returned nextPageUrl unchanged, preserving the original selection. An empty or short page can still have a continuation. See Pagination.

GET/v1/engrams/{id}/claims

The claims an engram holds now, in a stable order, each with the id Consolidate gave it. A filtered page can hold fewer than limit claims, even none, while more remain: follow nextPageUrl until it is null. Follow it with the same Workspace, filters and limit; a new fold invalidates the cursor.

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

Parameters

idstringrequired

path parameter.

workspacestringoptional

query parameter. One assigned Workspace. Required for keys with multiple assignments; inferred for one.

limitintegeroptional

query parameter.

Minimum: 1Maximum: 500

Default: 100

pagestringoptional

query parameter. The previous memory cursor, with the same selection. Follow the returned nextPageUrl unchanged.

Min length: 1Max length: 131072

experiencestringoptional

query parameter. Only the claims this experience contributed (an id POST /v1/experiences returned).

at[gt]stringoptional

query parameter. Claim observation time greater than this value.

at[gte]stringoptional

query parameter. Claim observation time at least this value.

at[lt]stringoptional

query parameter. Claim observation time less than this value.

at[lte]stringoptional

query parameter. Claim observation time at most this value.

Responses

One bounded page of claims.

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