Client

Get user profile

profile() -> ProfileResponse

POST/v4/profile

Add document

add() -> AddResponse

POST/v3/documents

ModelsExpand Collapse

class ProfileResponse: …

profile: Profile

buckets: Optional[Dict[str, List[str]]]

Per-bucket memory lists, keyed by bucket key

dynamic: Optional[List[str]]

Dynamic profile information (recent memories)

static: Optional[List[str]]

Static profile information that remains relevant long-term

search_results: Optional[SearchResults]

Search results if a search query was provided

results: List[SearchResultsResult]

Search results for the provided query

id: str

Memory entry ID or chunk ID

metadata: Optional[Dict[str, object]]

Memory metadata

similarity: float

Similarity score between the query and memory entry

maximum1

minimum0

updated_at: str

Memory last update date

formatdatetime

chunk: Optional[str]

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

chunks: Optional[List[SearchResultsResultChunk]]

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

content: str

Content of the chunk

document_id: str

ID of the document this chunk belongs to

position: float

Position of chunk in the document (0-indexed)

context: Optional[SearchResultsResultContext]

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

children: Optional[List[SearchResultsResultContextChild]]

memory: str

The contextual memory content

relation: Literal["updates", "extends", "derives"]

Relation type between this memory and its parent/child

One of the following:

"updates"

"extends"

"derives"

updated_at: str

Contextual memory last update date

formatdatetime

metadata: Optional[Dict[str, object]]

Contextual memory metadata

version: Optional[float]

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

parents: Optional[List[SearchResultsResultContextParent]]

memory: str

The contextual memory content

relation: Literal["updates", "extends", "derives"]

Relation type between this memory and its parent/child

One of the following:

"updates"

"extends"

"derives"

updated_at: str

Contextual memory last update date

formatdatetime

metadata: Optional[Dict[str, object]]

Contextual memory metadata

version: Optional[float]

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

One of the following:

documents: Optional[List[SearchResultsResultDocument]]

Associated documents for this memory entry

id: str

Document ID

created_at: str

Document creation date

formatdatetime

updated_at: str

Document last update date

formatdatetime

metadata: Optional[Dict[str, object]]

Document metadata (only included when documents=true)

summary: Optional[str]

Document summary (only included when summaries=true)

title: Optional[str]

Document title (only included when documents=true)

type: Optional[str]

Document type (only included when documents=true)

filepath: Optional[str]

Filepath of the source document this memory or chunk came from

is_aggregated: Optional[bool]

Indicates if this memory was created by aggregating multiple source memories

memory: Optional[str]

The memory content (only present for memory results)

root_memory_id: Optional[str]

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: Optional[float]

Version number of this memory entry

timing: float

Search timing in milliseconds

total: float

Total number of search results

class AddResponse: …

id: str

Unique identifier of the document

status: str

Status of the document