Skip to content
Get started

Client

Get user profile
client.profile(ProfileParams { containerTag, filters, q, threshold } body, RequestOptionsoptions?): ProfileResponse { profile, searchResults }
POST/v4/profile
Add document
client.add(AddParams { content, containerTag, containerTags, 6 more } body, RequestOptionsoptions?): AddResponse { id, status }
POST/v3/documents
ModelsExpand Collapse
ProfileResponse { profile, searchResults }
profile: Profile { dynamic, static }
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<unknown>

Search results for the provided query

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