-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathquickstart.html
More file actions
50 lines (50 loc) · 27 KB
/
quickstart.html
File metadata and controls
50 lines (50 loc) · 27 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-quickstart" data-has-hydrated=false><head><meta charset=UTF-8><meta name=generator content="Docusaurus v3.10.1"><title data-rh=true>Quickstart | AtomicMemory</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"/><meta data-rh=true name=twitter:card content=summary_large_image /><meta data-rh=true property=og:image content=https://docs.atomicmemory.ai/img/logo-full.svg /><meta data-rh=true name=twitter:image content=https://docs.atomicmemory.ai/img/logo-full.svg /><meta data-rh=true property=og:url content=https://docs.atomicmemory.ai/quickstart /><meta data-rh=true property=og:locale content=en /><meta data-rh=true name=docusaurus_locale content=en /><meta data-rh=true name=docsearch:language content=en /><meta data-rh=true name=docusaurus_version content=current /><meta data-rh=true name=docusaurus_tag content=docs-default-current /><meta data-rh=true name=docsearch:version content=current /><meta data-rh=true name=docsearch:docusaurus_tag content=docs-default-current /><meta data-rh=true property=og:title content="Quickstart | AtomicMemory"/><meta data-rh=true name=description content="Docker up, first ingest, first search, in under 2 minutes."/><meta data-rh=true property=og:description content="Docker up, first ingest, first search, in under 2 minutes."/><link data-rh=true rel=icon href=/img/logo.svg /><link data-rh=true rel=canonical href=https://docs.atomicmemory.ai/quickstart /><link data-rh=true rel=alternate href=https://docs.atomicmemory.ai/quickstart hreflang=en /><link data-rh=true rel=alternate href=https://docs.atomicmemory.ai/quickstart hreflang=x-default /><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.atomicmemory.ai/quickstart","name":"Quickstart","position":1}]}</script><link rel=preconnect href=https://fonts.googleapis.com><link rel=preconnect href=https://fonts.gstatic.com crossorigin=anonymous><link rel=stylesheet href="https://fonts.googleapis.com/css2?family=Work+Sans:wght@400;500;600;700;800&family=Fira+Mono:wght@400;500;700&display=swap"><link rel=stylesheet href=/assets/css/styles.224f5720.css /><script src=/assets/js/runtime~main.b62bc408.js defer></script><script src=/assets/js/main.af6c7e72.js defer></script></head><body><svg style="display: none;"><defs>
<symbol id=theme-svg-external-link viewBox="0 0 24 24"><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
</defs></svg>
<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme-87a")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||(window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light")),document.documentElement.setAttribute("data-theme-choice",t||"system")}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/img/logo-full.svg /><link rel=preload as=image href=/img/logo-full-white.svg /><div role=region aria-label="Skip to main content"><a class=skipToContent_fXgn href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/><div class=navbar__logo><img src=/img/logo-full.svg alt="AtomicMemory Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"/><img src=/img/logo-full-white.svg alt="AtomicMemory Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"/></div></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/>Platform</a><a class="navbar__item navbar__link" href=/sdk/overview>SDK</a><a class="navbar__item navbar__link" href=/cli>CLI</a><a class="navbar__item navbar__link" href=/integrations/overview>Integrations</a><a class="navbar__item navbar__link" href=/api-reference/http/conventions>API Reference</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href=https://github.com/atomicmemory/atomicmemory-core target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type=button disabled title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width=24 height=24 aria-hidden=true class="toggleIcon_g3eP lightToggleIcon_pyhR"><path fill=currentColor d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"/></svg><svg viewBox="0 0 24 24" width=24 height=24 aria-hidden=true class="toggleIcon_g3eP darkToggleIcon_wfgR"><path fill=currentColor d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"/></svg><svg viewBox="0 0 24 24" width=24 height=24 aria-hidden=true class="toggleIcon_g3eP systemToggleIcon_QzmC"><path fill=currentColor d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"/></svg></button></div><div class=navbarSearchContainer_Bca1></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_z2l0"><div class=docsWrapper_hBAB><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type=button></button><div class=docRoot_UBD9><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class=sidebarViewport_aRkj><div class=sidebar_njMd><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/><span title=Introduction class=linkLabel_WmDU>Introduction</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link menu__link--active" aria-current=page href=/quickstart><span title=Quickstart class=linkLabel_WmDU>Quickstart</span></a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role=button aria-expanded=true href=/platform/architecture><span title=Platform class=categoryLinkLabel_W154>Platform</span></a></div><ul class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/platform/architecture><span title=Architecture class=linkLabel_WmDU>Architecture</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/platform/composition><span title=Composition class=linkLabel_WmDU>Composition</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/platform/consuming-core><span title="Consuming core" class=linkLabel_WmDU>Consuming core</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/platform/stores><span title=Stores class=linkLabel_WmDU>Stores</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/platform/providers><span title=Providers class=linkLabel_WmDU>Providers</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/platform/scope><span title=Scope class=linkLabel_WmDU>Scope</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/platform/observability><span title=Observability class=linkLabel_WmDU>Observability</span></a></ul></ul></nav></div></div></aside><main class=docMainContainer_TBSr><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_xLCN"><div class=docItemContainer_jfFK><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_YNFT><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Quickstart</span></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type=button class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><div class=row><div class="col col--12 markdown"><header><h1 class="anchor anchorTarget_QU3I" id=quickstart><a href=#quickstart class=headingLink_no4V aria-label="Copy link to Quickstart" title="Copy link to Quickstart"><span aria-hidden=true data-markdown-ignore=true class=headingIcon_Pk3T>#</span><span class=headingText_IKAy>Quickstart</span></a></h1></header>
<blockquote data-llms-directive=true>
<p>Agent index: <a href=/llms.txt target=_blank rel="noopener noreferrer" class="">llms.txt</a></p>
</blockquote>
<p>Docker up, first ingest, first search, in under 2 minutes.</p>
<h2 class="anchor anchorTarget_QU3I" id=prerequisites><a href=#prerequisites class=headingLink_no4V aria-label="Copy link to Prerequisites" title="Copy link to Prerequisites"><span aria-hidden=true data-markdown-ignore=true class=headingIcon_Pk3T>#</span><span class=headingText_IKAy>Prerequisites</span></a></h2>
<ul>
<li class=""><strong>Docker</strong> (Docker Desktop or Docker Engine with <code>docker compose</code>)</li>
<li class=""><strong>An LLM / embedding provider</strong>, either:<!-- -->
<ul>
<li class="">An <strong>OpenAI API key</strong> (default path, zero extra setup), or</li>
<li class="">A local <strong>Ollama</strong> install if you prefer to run everything on your machine, see <a class="" href=/platform/providers>providers</a> for the env vars to swap in</li>
</ul>
</li>
</ul>
<p>That is all. The Docker stack brings its own Postgres with pgvector.</p>
<h2 class="anchor anchorTarget_QU3I" id=step-1-clone-and-start><a href=#step-1-clone-and-start class=headingLink_no4V aria-label="Copy link to Step 1, Clone and start" title="Copy link to Step 1, Clone and start"><span aria-hidden=true data-markdown-ignore=true class=headingIcon_Pk3T>#</span><span class=headingText_IKAy>Step 1, Clone and start</span></a></h2>
<p>Clone the core repo, copy the sample env file, drop in your API key, and bring the stack up.</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token function" style=color:#d73a49>git</span><span class="token plain"> clone https://github.com/atomicmemory/atomicmemory-core.git</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token builtin class-name">cd</span><span class="token plain"> atomicmemory-core</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token function" style=color:#d73a49>cp</span><span class="token plain"> .env.example .env</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token comment" style=color:#999988;font-style:italic># edit .env, set OPENAI_API_KEY</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token function" style=color:#d73a49>docker</span><span class="token plain"> compose up </span><span class="token parameter variable" style=color:#36acaa>-d</span><span class="token plain"> </span><span class="token parameter variable" style=color:#36acaa>--build</span><br/></div></code></pre></div></div>
<p>The <code>-d</code> runs detached; <code>--build</code> compiles the image on first run. Migrations execute automatically on container start, so the database is ready when the server binds to port <code>3050</code>.</p>
<h2 class="anchor anchorTarget_QU3I" id=step-2-verify-health><a href=#step-2-verify-health class=headingLink_no4V aria-label="Copy link to Step 2, Verify health" title="Copy link to Step 2, Verify health"><span aria-hidden=true data-markdown-ignore=true class=headingIcon_Pk3T>#</span><span class=headingText_IKAy>Step 2, Verify health</span></a></h2>
<p>Hit the memory subsystem health endpoint to confirm the server is live and see the active runtime config.</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token function" style=color:#d73a49>curl</span><span class="token plain"> http://localhost:3050/v1/memories/health</span><br/></div></code></pre></div></div>
<p>You should get back a JSON object with <code>"status": "ok"</code> and a <code>config</code> snapshot showing the selected embedding and LLM providers.</p>
<h2 class="anchor anchorTarget_QU3I" id=step-3-first-ingest><a href=#step-3-first-ingest class=headingLink_no4V aria-label="Copy link to Step 3, First ingest" title="Copy link to Step 3, First ingest"><span aria-hidden=true data-markdown-ignore=true class=headingIcon_Pk3T>#</span><span class=headingText_IKAy>Step 3, First ingest</span></a></h2>
<p>Send a conversation and let AtomicMemory extract structured facts, embed them, and run AUDN to decide what to store.</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token function" style=color:#d73a49>curl</span><span class="token plain"> </span><span class="token parameter variable" style=color:#36acaa>-X</span><span class="token plain"> POST http://localhost:3050/v1/memories/ingest </span><span class="token punctuation" style=color:#393A34>\</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token parameter variable" style=color:#36acaa>-H</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>'Content-Type: application/json'</span><span class="token plain"> </span><span class="token punctuation" style=color:#393A34>\</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token parameter variable" style=color:#36acaa>-d</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>'{"user_id":"alice","conversation":"user: I ship Go backends and TypeScript frontends.","source_site":"quickstart"}'</span><br/></div></code></pre></div></div>
<p>The response reports <code>facts_extracted</code>, <code>memories_stored</code>, <code>stored_memory_ids</code>, and <code>updated_memory_ids</code>, that is AUDN telling you what survived dedup and contradiction checks.</p>
<h2 class="anchor anchorTarget_QU3I" id=step-4-first-search><a href=#step-4-first-search class=headingLink_no4V aria-label="Copy link to Step 4, First search" title="Copy link to Step 4, First search"><span aria-hidden=true data-markdown-ignore=true class=headingIcon_Pk3T>#</span><span class=headingText_IKAy>Step 4, First search</span></a></h2>
<p>Query the memories you just created. AtomicMemory runs semantic retrieval, applies the active retrieval profile, and packages the result. Hybrid retrieval (vector + BM25/FTS with RRF fusion) is available through the <code>quality</code> profile or per-request config overrides, but the default <code>balanced</code> profile keeps it off.</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token function" style=color:#d73a49>curl</span><span class="token plain"> </span><span class="token parameter variable" style=color:#36acaa>-X</span><span class="token plain"> POST http://localhost:3050/v1/memories/search </span><span class="token punctuation" style=color:#393A34>\</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token parameter variable" style=color:#36acaa>-H</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>'Content-Type: application/json'</span><span class="token plain"> </span><span class="token punctuation" style=color:#393A34>\</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token parameter variable" style=color:#36acaa>-d</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>'{"user_id":"alice","query":"what stack does alice use?"}'</span><br/></div></code></pre></div></div>
<p>The response carries three things worth noting:</p>
<ul>
<li class=""><strong><code>memories</code></strong>, ranked results with <code>similarity</code>, composite <code>score</code>, and <code>importance</code></li>
<li class=""><strong><code>injection_text</code></strong>, a pre-formatted markdown block, date-stamped and grouped by source, ready to paste directly into an LLM system prompt</li>
<li class=""><strong><code>observability</code></strong>, stable trace metadata (timing, retrieval mode, citations) so you can wire evals and dashboards without reverse-engineering internals</li>
</ul>
<h2 class="anchor anchorTarget_QU3I" id=what-next><a href=#what-next class=headingLink_no4V aria-label="Copy link to What next" title="Copy link to What next"><span aria-hidden=true data-markdown-ignore=true class=headingIcon_Pk3T>#</span><span class=headingText_IKAy>What next</span></a></h2>
<ul>
<li class=""><strong>Swap to a local embedding model</strong>, run entirely offline with <code>transformers</code> (WASM) or <code>ollama</code>. See <a class="" href=/platform/providers>providers</a>.</li>
<li class=""><strong>Workspace-scoped memory</strong>, separate personal memory from team memory with first-class scope dispatch. See <a class="" href=/platform/scope>scope</a>.</li>
<li class=""><strong>Full API reference</strong>, every endpoint, request, and response shape. Start with <a class="" href=/api-reference/http/ingest-memory>ingest</a>.</li>
</ul>
<h2 class="anchor anchorTarget_QU3I" id=using-the-typescript-sdk><a href=#using-the-typescript-sdk class=headingLink_no4V aria-label="Copy link to Using the TypeScript SDK" title="Copy link to Using the TypeScript SDK"><span aria-hidden=true data-markdown-ignore=true class=headingIcon_Pk3T>#</span><span class=headingText_IKAy>Using the TypeScript SDK</span></a></h2>
<p>If you're building in TypeScript or JavaScript, the <a class="" href=/sdk/quickstart>SDK Quickstart</a> shows the same ingest-and-search round trip above, typed, with the SDK's policy layer (capture / injection gates) in front of the same core endpoints. The SDK is not required, everything above is just HTTP, but it handles the ergonomics, the scope helpers, and the backend-agnostic routing if you want to target more than one memory engine from the same code.</p>
<h2 class="anchor anchorTarget_QU3I" id=running-in-production><a href=#running-in-production class=headingLink_no4V aria-label="Copy link to Running in production" title="Copy link to Running in production"><span aria-hidden=true data-markdown-ignore=true class=headingIcon_Pk3T>#</span><span class=headingText_IKAy>Running in production</span></a></h2>
<p>The Docker Compose stack above is the same shape you would deploy to a server or a managed container platform. For hardened production guidance, managed Postgres, secret handling, CORS, and the <code>CORE_RUNTIME_CONFIG_MUTATION_ENABLED</code> gate, follow the deployment section of the <a href=https://github.com/atomicmemory/atomicmemory-core#deployment target=_blank rel="noopener noreferrer" class="">core repo README</a>.</div></div></div><div class=row><div class="col col--12"><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href=https://github.com/atomicmemory/atomicmemory-docs/edit/main/docs/quickstart.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_Z9Sw aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></div></div></article><div class=row><div class="col col--12"><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Introduction</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/platform/architecture><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Architecture</div></a></nav></div></div></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#prerequisites class="table-of-contents__link toc-highlight">Prerequisites</a><li><a href=#step-1-clone-and-start class="table-of-contents__link toc-highlight">Step 1, Clone and start</a><li><a href=#step-2-verify-health class="table-of-contents__link toc-highlight">Step 2, Verify health</a><li><a href=#step-3-first-ingest class="table-of-contents__link toc-highlight">Step 3, First ingest</a><li><a href=#step-4-first-search class="table-of-contents__link toc-highlight">Step 4, First search</a><li><a href=#what-next class="table-of-contents__link toc-highlight">What next</a><li><a href=#using-the-typescript-sdk class="table-of-contents__link toc-highlight">Using the TypeScript SDK</a><li><a href=#running-in-production class="table-of-contents__link toc-highlight">Running in production</a></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/>Introduction</a><li class=footer__item><a class=footer__link-item href=/quickstart>Quickstart</a><li class=footer__item><a class=footer__link-item href=/sdk/overview>SDK</a><li class=footer__item><a class=footer__link-item href=/api-reference/http/ingest-memory>API Reference</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Code</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/atomicmemory/atomicmemory-core target=_blank rel="noopener noreferrer" class=footer__link-item>atomicmemory-core<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a href=https://github.com/atomicmemory/atomicmemory-sdk target=_blank rel="noopener noreferrer" class=footer__link-item>atomicmemory-sdk<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/atomicmemory target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2026 AtomicMemory. Apache-2.0 licensed.</div></div></div></footer></div></body>