The MemMachineClient serves as the unified API for memory management, project operations, and server health checks. It is designed to be the starting point for all interactions with the MemMachine service.
The following example demonstrates the recommended pattern for initializing the client and traversing to a specific project and memory instance.
import MemMachineClient from '@memmachine/client';async function main() { // 1. Initialize the client const client = new MemMachineClient({ api_key: 'your_api_key' }); // 2. Access a specific project const project = client.project({ org_id: 'your_org_id', project_id: 'your_project_id' }); // 3. Initialize memory for that project const memory = project.memory(); // 4. Perform high-level health checks const status = await client.healthCheck(); console.log(`Server Status: ${status.status}`);}main();
For best performance, reuse a single MemMachineClient instance across your application to leverage connection pooling through the internal AxiosInstance.
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"MemMachine Documentation","colors":{"primary":"#9B63E6","light":"#CE63C8","dark":"#120919"},"logo":{"light":"https://mintcdn.com/memmachine/BpRF5o8wX7ODMyIp/logo/memmachine-blue-logo-banner.png?fit=max\u0026auto=format\u0026n=BpRF5o8wX7ODMyIp\u0026q=85\u0026s=9fa6026f3171ba59566b89687f00b96e","dark":"https://mintcdn.com/memmachine/BpRF5o8wX7ODMyIp/logo/memmachine-white-logo-banner.png?fit=max\u0026auto=format\u0026n=BpRF5o8wX7ODMyIp\u0026q=85\u0026s=8a800076f7ea2651c979f0cb78b77ced"},"favicon":"https://mintcdn.com/memmachine/BpRF5o8wX7ODMyIp/favicon.ico?fit=max\u0026auto=format\u0026n=BpRF5o8wX7ODMyIp\u0026q=85\u0026s=76c8303c9afb6fbcbfe209dae10da302","background":{"decoration":"windows","color":{"dark":"#0D0713"}},"navbar":{"links":[{"href":"https://discord.gg/usydANvKqD","label":"Support"},{"href":"https://console.memmachine.ai","label":"Platform Console"}]},"footer":{"socials":{"github":"https://github.com/MemMachine/MemMachine","discord":"https://discord.gg/usydANvKqD"}},"integrations":{"gtm":{"tagId":"GTM-WDX7ZBC7"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.memmachine.ai/"},{"anchor":"Community","icon":"slack","href":"https://memmachine.ai/community"},{"anchor":"Blog","icon":"newspaper","href":"https://memmachine.ai/blog"},{"anchor":"Platform","icon":"box-open","href":"https://console.memmachine.ai/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"memmachine","hasAudioNarration":false,"actualSubdomain":"memmachine","customDomains":["docs.memmachine.ai"],"gitSource":{"type":"github","owner":"memmachine","repo":"memmachine","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ac988d3bf9812e94944516a","collectionId":"b6a7284d-b4d6-49cf-8629-c17c9cbd84b3","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ac988d3bf9812e94944516a"},"entitlements":{},"buildId":"6ae5210efffb63bb5d9d53d8","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"OpenSource API","count":88},{"language":"default","tag":"REST API","count":54},{"language":"default","tag":"Docs","count":29},{"language":"default","tag":"Typescript REST SDK","count":20},{"language":"default","tag":"Platform","count":16},{"language":"default","tag":"Interfaces","count":13},{"language":"default","tag":"Platform API","count":12},{"language":"default","tag":"Configuration","count":11},{"language":"default","tag":"Examples","count":10},{"language":"default","tag":"Integrations","count":10}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api_reference/ts-rest/classes/MemMachineClient","slug":"/api_reference/ts-rest/classes/MemMachineClient","pageMetadata":{"title":"MemMachineClient","description":"The primary entry point for the MemMachine TypeScript REST client library.","href":"/api_reference/ts-rest/classes/MemMachineClient"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"The primary entry point for the MemMachine TypeScript REST client library.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,hr:`hr`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`overview`,children:`Overview`}),`\n`,_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`MemMachineClient`}),` serves as the unified API for memory management, project operations, and server health checks. It is designed to be the starting point for all interactions with the MemMachine service.`]}),`\n`,_jsx(Heading,{level:`3`,id:`key-features`,children:`Key Features`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Hierarchical Management:`}),` Generate `,_jsx(_components.code,{children:`MemMachineMemory`}),` and `,_jsx(_components.code,{children:`MemMachineProject`}),` instances for scoped operations.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Resource Discovery:`}),` List all projects accessible to your API key.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Observability:`}),` Access Prometheus metrics and perform real-time health checks on the server.`]}),`\n`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`constructor`,children:`Constructor`}),`\n`,_jsx(Heading,{level:`3`,id:`new-memmachineclient`,children:_jsx(_components.code,{children:`new MemMachineClient()`})}),`\n`,_jsx(_components.p,{children:`Initializes a new client instance.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`new`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` MemMachineClient`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`options`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`?:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` ClientOptions`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`]})})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:_jsx(_components.strong,{children:`Parameter`})}),_jsx(_components.th,{children:_jsx(_components.strong,{children:`Type`})}),_jsx(_components.th,{children:_jsx(_components.strong,{children:`Description`})})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`options`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/api_reference/ts-rest/interfaces/ClientOptions`,children:_jsx(_components.code,{children:`ClientOptions`})})}),_jsxs(_components.td,{children:[`(Optional) Configuration including `,_jsx(_components.code,{children:`api_key`}),`, `,_jsx(_components.code,{children:`base_url`}),`, `,_jsx(_components.code,{children:`timeout`}),`, and `,_jsx(_components.code,{children:`max_retries`}),`.`]})]})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`properties`,children:`Properties`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:_jsx(_components.strong,{children:`Property`})}),_jsx(_components.th,{children:_jsx(_components.strong,{children:`Type`})}),_jsx(_components.th,{children:_jsx(_components.strong,{children:`Description`})})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`client`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`AxiosInstance`})}),_jsx(_components.td,{children:`The underlying Axios instance used for making HTTP requests.`})]})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`methods`,children:`Methods`}),`\n`,_jsx(Heading,{level:`3`,id:`project`,children:_jsx(_components.code,{children:`project()`})}),`\n`,_jsxs(_components.p,{children:[`Creates a `,_jsx(_components.code,{children:`MemMachineProject`}),` instance for managing a specific project.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:_jsx(_components.strong,{children:`Parameter`})}),_jsx(_components.th,{children:_jsx(_components.strong,{children:`Type`})}),_jsx(_components.th,{children:_jsx(_components.strong,{children:`Description`})})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`projectContext`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/api_reference/ts-rest/interfaces/ProjectContext`,children:_jsx(_components.code,{children:`ProjectContext`})})}),_jsxs(_components.td,{children:[`Context options (e.g., `,_jsx(_components.code,{children:`org_id`}),`, `,_jsx(_components.code,{children:`project_id`}),`).`]})]})})]}),`\n`,_jsx(Heading,{level:`3`,id:`getprojects-orgid`,children:_jsx(_components.code,{children:`getProjects(orgId)`})}),`\n`,_jsx(_components.p,{children:`Retrieves projects belonging to the specified organization.`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Returns:`}),` `,_jsx(_components.code,{children:`Promise\u003cProject[]>`})]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Throws:`}),` `,_jsx(_components.a,{href:`/api_reference/ts-rest/classes/MemMachineAPIError`,children:_jsx(_components.code,{children:`MemMachineAPIError`})})]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`healthcheck`,children:_jsx(_components.code,{children:`healthCheck()`})}),`\n`,_jsx(_components.p,{children:`Checks the current health status of the MemMachine server.`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Returns:`}),` `,_jsx(_components.code,{children:`Promise\u003cHealthStatus>`})]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Throws:`}),` `,_jsx(_components.a,{href:`/api_reference/ts-rest/classes/MemMachineAPIError`,children:_jsx(_components.code,{children:`MemMachineAPIError`})})]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`getmetrics`,children:_jsx(_components.code,{children:`getMetrics()`})}),`\n`,_jsx(_components.p,{children:`Retrieves Prometheus metrics from the server in string format.`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Returns:`}),` `,_jsx(_components.code,{children:`Promise\u003cstring>`})]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Throws:`}),` `,_jsx(_components.a,{href:`/api_reference/ts-rest/classes/MemMachineAPIError`,children:_jsx(_components.code,{children:`MemMachineAPIError`})})]}),`\n`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`usage-example`,children:`Usage Example`}),`\n`,_jsx(_components.p,{children:`The following example demonstrates the recommended pattern for initializing the client and traversing to a specific project and memory instance.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`23`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`23`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` MemMachineClient`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` from`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '@memmachine/client'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`async`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` function`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` main`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`() {`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` // 1. Initialize the client`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` client`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` new`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` MemMachineClient`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({ `})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` api_key:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'your_api_key'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` `})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` });`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` // 2. Access a specific project`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` project`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` client`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`project`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({ `})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` org_id:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'your_org_id'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` project_id:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'your_project_id'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` `})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` });`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` // 3. Initialize memory for that project`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` memory`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` project`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`memory`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`();`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` // 4. Perform high-level health checks`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` status`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` client`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`healthCheck`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`();`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` console`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`log`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:\"`Server Status: \"}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#569CD6`},children:\"${\"}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`status`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`status`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:\"`\"}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`main`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`();`})]}),`\n`]})})}),`\n`,_jsxs(Tip,{children:[` For best performance, reuse a single `,_jsx(_components.code,{children:`MemMachineClient`}),` instance across your application to leverage connection pooling through the internal `,_jsx(_components.code,{children:`AxiosInstance`}),`. `]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"MemMachineClient","description":"The primary entry point for the MemMachine TypeScript REST client library.","href":"/api_reference/ts-rest/classes/MemMachineClient"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Overview","slug":"overview","depth":2,"children":[{"title":"Key Features","slug":"key-features","depth":3,"children":[]}]},{"title":"Constructor","slug":"constructor","depth":2,"children":[{"title":"new MemMachineClient()","slug":"new-memmachineclient","depth":3,"children":[]}]},{"title":"Properties","slug":"properties","depth":2,"children":[]},{"title":"Methods","slug":"methods","depth":2,"children":[{"title":"project()","slug":"project","depth":3,"children":[]},{"title":"getProjects(orgId)","slug":"getprojects-orgid","depth":3,"children":[]},{"title":"healthCheck()","slug":"healthcheck","depth":3,"children":[]},{"title":"getMetrics()","slug":"getmetrics","depth":3,"children":[]}]},{"title":"Usage Example","slug":"usage-example","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"memmachine","siteName":"MemMachine Documentation","title":"MemMachineClient - MemMachine Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-10T00:37:48.584Z","originalFileLocation":"api_reference/ts-rest/classes/MemMachineClient.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"The primary entry point for the MemMachine TypeScript REST client library.\">\u003cmeta data-mint-head name=\"application-name\" content=\"MemMachine Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/memmachine/HrDv83ZGR-Xf8GLl/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/memmachine/HrDv83ZGR-Xf8GLl/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/memmachine/HrDv83ZGR-Xf8GLl/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/memmachine/HrDv83ZGR-Xf8GLl/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/memmachine/HrDv83ZGR-Xf8GLl/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/memmachine/HrDv83ZGR-Xf8GLl/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/memmachine/HrDv83ZGR-Xf8GLl/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/memmachine/HrDv83ZGR-Xf8GLl/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/memmachine/HrDv83ZGR-Xf8GLl/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"MemMachineClient - MemMachine Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"The primary entry point for the MemMachine TypeScript REST client library.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"MemMachine Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.memmachine.ai/api_reference/ts-rest/classes/MemMachineClient\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://memmachine.mintlify.app/_mintlify/api/og/v2?division=Classes\u0026amp;title=MemMachineClient\u0026amp;description=The+primary+entry+point+for+the+MemMachine+TypeScript+REST+client+library.\u0026amp;theme=982642f3373107673f012205\u0026amp;signature=d689ee528d172da3670a71ac63cd5dbe38fd7a10193570cffe48ccaf1aea1ac3\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"MemMachineClient - MemMachine Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The primary entry point for the MemMachine TypeScript REST client library.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://memmachine.mintlify.app/_mintlify/api/og/v2?division=Classes\u0026amp;title=MemMachineClient\u0026amp;description=The+primary+entry+point+for+the+MemMachine+TypeScript+REST+client+library.\u0026amp;theme=982642f3373107673f012205\u0026amp;signature=d689ee528d172da3670a71ac63cd5dbe38fd7a10193570cffe48ccaf1aea1ac3\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/memmachine/HrDv83ZGR-Xf8GLl/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"MemMachine Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#9B63E6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.memmachine.ai/api_reference/ts-rest/classes/MemMachineClient\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api_reference/ts-rest/classes/MemMachineClient.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.memmachine.ai/#organization\",\"name\":\"MemMachine Documentation\",\"url\":\"https://docs.memmachine.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/memmachine/BpRF5o8wX7ODMyIp/logo/memmachine-blue-logo-banner.png?fit=max\u0026auto=format\u0026n=BpRF5o8wX7ODMyIp\u0026q=85\u0026s=9fa6026f3171ba59566b89687f00b96e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.memmachine.ai#website\",\"name\":\"MemMachine Documentation\",\"url\":\"https://docs.memmachine.ai\",\"publisher\":{\"@id\":\"https://docs.memmachine.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.memmachine.ai/api_reference/ts-rest/classes/MemMachineClient#webpage\",\"url\":\"https://docs.memmachine.ai/api_reference/ts-rest/classes/MemMachineClient\",\"name\":\"MemMachineClient\",\"description\":\"The primary entry point for the MemMachine TypeScript REST client library.\",\"dateModified\":\"2026-10-10T00:37:48.584Z\",\"isPartOf\":{\"@id\":\"https://docs.memmachine.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.memmachine.ai/api_reference/ts-rest/classes/MemMachineClient#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.memmachine.ai/api_reference/ts-rest/classes/MemMachineClient#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Typescript REST SDK\",\"item\":\"https://docs.memmachine.ai/api_reference/ts-rest/typescript\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"MemMachineClient\",\"item\":\"https://docs.memmachine.ai/api_reference/ts-rest/classes/MemMachineClient\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.memmachine.ai/api_reference/ts-rest/classes/MemMachineClient#article\",\"headline\":\"MemMachineClient\",\"name\":\"MemMachineClient\",\"description\":\"The primary entry point for the MemMachine TypeScript REST client library.\",\"url\":\"https://docs.memmachine.ai/api_reference/ts-rest/classes/MemMachineClient\",\"mainEntityOfPage\":{\"@id\":\"https://docs.memmachine.ai/api_reference/ts-rest/classes/MemMachineClient#webpage\"},\"dateModified\":\"2026-10-10T00:37:48.584Z\",\"publisher\":{\"@id\":\"https://docs.memmachine.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.memmachine.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"MemMachine Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"MemMachine Documentation","nav":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.memmachine.ai/"},{"anchor":"Community","icon":"slack","href":"https://memmachine.ai/community"},{"anchor":"Blog","icon":"newspaper","href":"https://memmachine.ai/blog"},{"anchor":"Platform","icon":"box-open","href":"https://console.memmachine.ai/"}]},"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":"/getting_started/introduction"}]},{"tab":"OpenSource API","groups":[{"group":"Introduction","pages":[{"title":"Welcome","icon":"face-smile","href":"/api_reference/intro"}]},{"group":"MCP Tools","pages":[{"title":"Tools Reference","icon":"square-binary","href":"/api_reference/mcp"}]},{"group":"REST API","pages":[{"group":"Configuration","pages":[{"title":"Get Config","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/config","href":"/api-reference/configuration/get-config"},{"title":"Update Memory Config Endpoint","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v2/config/memory","href":"/api-reference/configuration/update-memory-config-endpoint"},{"title":"Get Episodic Memory Config","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/config/memory/episodic","href":"/api-reference/configuration/get-episodic-memory-config"},{"title":"Update Episodic Memory Config","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v2/config/memory/episodic","href":"/api-reference/configuration/update-episodic-memory-config"},{"title":"Get Long Term Memory Config","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/config/memory/episodic/long_term","href":"/api-reference/configuration/get-long-term-memory-config"},{"title":"Update Long Term Memory Config","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v2/config/memory/episodic/long_term","href":"/api-reference/configuration/update-long-term-memory-config"},{"title":"Get Short Term Memory Config","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/config/memory/episodic/short_term","href":"/api-reference/configuration/get-short-term-memory-config"},{"title":"Update Short Term Memory Config","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v2/config/memory/episodic/short_term","href":"/api-reference/configuration/update-short-term-memory-config"},{"title":"Get Semantic Memory Config","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/config/memory/semantic","href":"/api-reference/configuration/get-semantic-memory-config"},{"title":"Update Semantic Memory Config","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v2/config/memory/semantic","href":"/api-reference/configuration/update-semantic-memory-config"},{"title":"Get Resources","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/config/resources","href":"/api-reference/configuration/get-resources"}]},{"group":"Episodic Configuration","pages":[{"title":"Configure Episodic Memory","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memory/episodic/config","href":"/api-reference/episodic-configuration/configure-episodic-memory"},{"title":"Get Episodic Memory Config","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memory/episodic/config/get","href":"/api-reference/episodic-configuration/get-episodic-memory-config"},{"title":"Configure Long Term Memory","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memory/episodic/long_term/config","href":"/api-reference/episodic-configuration/configure-long-term-memory"},{"title":"Get Long Term Memory Config","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memory/episodic/long_term/config/get","href":"/api-reference/episodic-configuration/get-long-term-memory-config"},{"title":"Configure Short Term Memory","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memory/episodic/short_term/config","href":"/api-reference/episodic-configuration/configure-short-term-memory"},{"title":"Get Short Term Memory Config","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memory/episodic/short_term/config/get","href":"/api-reference/episodic-configuration/get-short-term-memory-config"}]},{"group":"Memories","pages":[{"title":"Add Memories","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memories","href":"/api-reference/memories/add-memories"},{"title":"Delete Episodic Memory","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memories/episodic/delete","href":"/api-reference/memories/delete-episodic-memory"},{"title":"List Memories","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memories/list","href":"/api-reference/memories/list-memories"},{"title":"Search Memories","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memories/search","href":"/api-reference/memories/search-memories"},{"title":"Delete Semantic Memory","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memories/semantic/delete","href":"/api-reference/memories/delete-semantic-memory"}]},{"group":"Projects","pages":[{"title":"Create Project","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/projects","href":"/api-reference/projects/create-project"},{"title":"Delete Project","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/projects/delete","href":"/api-reference/projects/delete-project"},{"title":"Get Episode Count","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/projects/episode_count/get","href":"/api-reference/projects/get-episode-count"},{"title":"Get Project","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/projects/get","href":"/api-reference/projects/get-project"},{"title":"List Projects","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/projects/list","href":"/api-reference/projects/list-projects"}]},{"group":"Resources","pages":[{"title":"Add Embedder Endpoint","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/config/resources/embedders","href":"/api-reference/resources/add-embedder-endpoint"},{"title":"Delete Embedder Endpoint","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v2/config/resources/embedders/{name}","href":"/api-reference/resources/delete-embedder-endpoint"},{"title":"Retry Embedder Endpoint","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/config/resources/embedders/{name}/retry","href":"/api-reference/resources/retry-embedder-endpoint"},{"title":"Add Language Model Endpoint","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/config/resources/language_models","href":"/api-reference/resources/add-language-model-endpoint"},{"title":"Delete Language Model Endpoint","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v2/config/resources/language_models/{name}","href":"/api-reference/resources/delete-language-model-endpoint"},{"title":"Retry Language Model Endpoint","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/config/resources/language_models/{name}/retry","href":"/api-reference/resources/retry-language-model-endpoint"},{"title":"Retry Reranker Endpoint","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/config/resources/rerankers/{name}/retry","href":"/api-reference/resources/retry-reranker-endpoint"}]},{"group":"Semantic Memory: Categories","pages":[{"title":"Add Semantic Category","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memories/semantic/category","href":"/api-reference/semantic-memory:-categories/add-semantic-category"},{"title":"Delete Semantic Category","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memories/semantic/category/delete","href":"/api-reference/semantic-memory:-categories/delete-semantic-category"},{"title":"Disable Semantic Category","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memories/semantic/category/disable","href":"/api-reference/semantic-memory:-categories/disable-semantic-category"},{"title":"Get Semantic Category","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memories/semantic/category/get","href":"/api-reference/semantic-memory:-categories/get-semantic-category"},{"title":"Get Semantic Category Set Ids","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memories/semantic/category/set_ids/get","href":"/api-reference/semantic-memory:-categories/get-semantic-category-set-ids"},{"title":"Add Semantic Tag","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memories/semantic/category/tag","href":"/api-reference/semantic-memory:-categories/add-semantic-tag"},{"title":"Delete Semantic Tag","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memories/semantic/category/tag/delete","href":"/api-reference/semantic-memory:-categories/delete-semantic-tag"},{"title":"Add Semantic Category Template","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memories/semantic/category/template","href":"/api-reference/semantic-memory:-categories/add-semantic-category-template"},{"title":"List Semantic Category Templates","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memories/semantic/category/template/list","href":"/api-reference/semantic-memory:-categories/list-semantic-category-templates"}]},{"group":"Semantic Memory: Features","pages":[{"title":"Add Feature","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memories/semantic/feature","href":"/api-reference/semantic-memory:-features/add-feature"},{"title":"Get Feature","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memories/semantic/feature/get","href":"/api-reference/semantic-memory:-features/get-feature"},{"title":"Update Feature","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memories/semantic/feature/update","href":"/api-reference/semantic-memory:-features/update-feature"}]},{"group":"Semantic Memory: Sets","pages":[{"title":"Configure Semantic Set","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memories/semantic/set/configure","href":"/api-reference/semantic-memory:-sets/configure-semantic-set"},{"title":"Get Semantic Set Id","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memories/semantic/set_id/get","href":"/api-reference/semantic-memory:-sets/get-semantic-set-id"},{"title":"List Semantic Set Ids","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memories/semantic/set_id/list","href":"/api-reference/semantic-memory:-sets/list-semantic-set-ids"},{"title":"Create Semantic Set Type","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memories/semantic/set_type","href":"/api-reference/semantic-memory:-sets/create-semantic-set-type"},{"title":"Delete Semantic Set Type","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memories/semantic/set_type/delete","href":"/api-reference/semantic-memory:-sets/delete-semantic-set-type"},{"title":"List Semantic Set Types","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v2/memories/semantic/set_type/list","href":"/api-reference/semantic-memory:-sets/list-semantic-set-types"}]},{"group":"System","pages":[{"title":"Health Check","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/health","href":"/api-reference/system/health-check"},{"title":"Metrics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/metrics","href":"/api-reference/system/metrics"}]}]},{"group":"Typescript REST SDK","pages":[{"title":"TypeScript SDK","description":"The primary SDK for integrating MemMachine memory into TypeScript and JavaScript applications.","icon":"code","href":"/api_reference/ts-rest/typescript"},{"group":"Classes","pages":[{"title":"MemMachineClient","href":"/api_reference/ts-rest/classes/MemMachineClient"},{"title":"MemMachineAPIError","description":"Custom error class for handling MemMachine SDK and API failures.","href":"/api_reference/ts-rest/classes/MemMachineAPIError"},{"title":"MemMachineMemory","href":"/api_reference/ts-rest/classes/MemMachineMemory"},{"title":"MemMachineProject","href":"/api_reference/ts-rest/classes/MemMachineProject"}]},{"group":"Interfaces","pages":[{"title":"ClientOptions","href":"/api_reference/ts-rest/interfaces/ClientOptions"},{"title":"ProjectContext","href":"/api_reference/ts-rest/interfaces/ProjectContext"},{"title":"MemoryContext","href":"/api_reference/ts-rest/interfaces/MemoryContext"},{"title":"CreateProjectOptions","href":"/api_reference/ts-rest/interfaces/CreateProjectOptions"},{"title":"AddMemoryOptions","href":"/api_reference/ts-rest/interfaces/AddMemoryOptions"},{"title":"SearchMemoriesOptions","href":"/api_reference/ts-rest/interfaces/SearchMemoriesOptions"},{"title":"ListMemoriesOptions","href":"/api_reference/ts-rest/interfaces/ListMemoriesOptions"},{"title":"Project","href":"/api_reference/ts-rest/interfaces/Project"},{"title":"AddMemoryResult","href":"/api_reference/ts-rest/interfaces/AddMemoryResult"},{"title":"SearchMemoriesResult","href":"/api_reference/ts-rest/interfaces/SearchMemoriesResult"},{"title":"EpisodicMemory","href":"/api_reference/ts-rest/interfaces/EpisodicMemory"},{"title":"SemanticMemory","href":"/api_reference/ts-rest/interfaces/SemanticMemory"},{"title":"HealthStatus","href":"/api_reference/ts-rest/interfaces/HealthStatus"}]},{"group":"Types","pages":[{"title":"MemoryProducerRole","href":"/api_reference/ts-rest/types/MemoryProducerRole"},{"title":"MemoryType","href":"/api_reference/ts-rest/types/MemoryType"}]}]},{"group":"PythonSDK Client","pages":[{"title":"Client Introduction","icon":"python","href":"/api_reference/python/client"},{"title":"Client API","icon":"code","href":"/api_reference/python/client_api"},{"title":"Project API","icon":"folder","href":"/api_reference/python/project_api"},{"title":"Memories API","icon":"brain","href":"/api_reference/python/memory_api"},{"title":"Semantic API","icon":"diagram-project","href":"/api_reference/python/semantic_api"},{"title":"Configuration API","icon":"gear","href":"/api_reference/python/config_api"},{"title":"System API","icon":"microchip","href":"/api_reference/python/system_api"}]},{"group":"Python SDK Server","pages":[{"title":"Server Implementation","icon":"server","href":"/api_reference/python/server"},{"title":"Memory Types \u0026 Models","icon":"cube","href":"/api_reference/python/memory_types"},{"title":"Episodic Memory","icon":"brain","href":"/api_reference/python/episodic_memory"},{"title":"Semantic Memory","icon":"diagram-project","href":"/api_reference/python/semantic_memory"},{"title":"Episodic Memory Manager","icon":"sitemap","href":"/api_reference/python/episodic_memory_manager"}]}]},{"tab":"Examples","pages":[{"title":"Examples","href":"/examples/introduction"}]},{"tab":"Platform","pages":[{"title":"Platform","href":"/platform/introduction"}]}]},"basePath":"","title":"MemMachineClient - MemMachine Documentation","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":[],"chunks":[]}