Client

Get user profile

client.profile(, ?): ProfileResponse { profile, searchResults }

POST/v4/profile

Add document

client.add(, ?): AddResponse { id, status }

POST/v3/documents

ModelsExpand Collapse

ProfileResponse { profile, searchResults }

profile: Profile { buckets, dynamic, static }

buckets?: Record<string, Array<string>>

Per-bucket memory lists, keyed by bucket key

dynamic?: Array<string>

Dynamic profile information (recent memories)

static?: Array<string>

Static profile information that remains relevant long-term

searchResults?: SearchResults { results, timing, total }

Search results if a search query was provided

results: Array<Result>

Search results for the provided query

id: string

Memory entry ID or chunk ID

metadata: Record<string, unknown> | null

Memory metadata

similarity: number

Similarity score between the query and memory entry

maximum1

minimum0

updatedAt: string

Memory last update date

formatdatetime

chunk?: string

The chunk content (only present for chunk results from hybrid search)

chunks?: Array<Chunk>

Relevant chunks from associated documents (only included when chunks=true)

content: string

Content of the chunk

documentId: string

ID of the document this chunk belongs to

position: number

Position of chunk in the document (0-indexed)

context?: Context { children, parents, related }

Object containing version history (parents/children via updates) and related memories (extends/derives)

children?: Array<Child>

memory: string

The contextual memory content

relation: "updates" | "extends" | "derives"

Relation type between this memory and its parent/child

One of the following:

"updates"

"extends"

"derives"

updatedAt: string

Contextual memory last update date

formatdatetime

metadata?: Record<string, unknown> | null

Contextual memory metadata

version?: number | null

Relative version distance from the primary memory (+1 for direct child, +2 for grand-child, etc.)

parents?: Array<Parent>

memory: string

The contextual memory content

relation: "updates" | "extends" | "derives"

Relation type between this memory and its parent/child

One of the following:

"updates"

"extends"

"derives"

updatedAt: string

Contextual memory last update date

formatdatetime

metadata?: Record<string, unknown> | null

Contextual memory metadata

version?: number | null

Relative version distance from the primary memory (-1 for direct parent, -2 for grand-parent, etc.)

One of the following:

documents?: Array<Document>

Associated documents for this memory entry

id: string

Document ID

createdAt: string

Document creation date

formatdatetime

updatedAt: string

Document last update date

formatdatetime

metadata?: Record<string, unknown> | null

Document metadata (only included when documents=true)

summary?: string | null

Document summary (only included when summaries=true)

title?: string

Document title (only included when documents=true)

type?: string

Document type (only included when documents=true)

filepath?: string | null

Filepath of the source document this memory or chunk came from

isAggregated?: boolean

Indicates if this memory was created by aggregating multiple source memories

memory?: string

The memory content (only present for memory results)

rootMemoryId?: string | null

ID of the root (first version) memory entry this one descends from. Null for memories that have never been superseded. Only present on memory results, not on standalone chunk results.

version?: number | null

Version number of this memory entry

timing: number

Search timing in milliseconds

total: number

Total number of search results

AddResponse { id, status }

id: string

Unique identifier of the document

status: string

Status of the document