my-project-public

repository

loading code, commits, and activity

repositories

loading repo index

#1	---
#2	title: Integration Guide Template
#3	description: "Pattern for pairing Mem0 with third-party tools."
#4	icon: "plug"
#5	---
#6
#7	# Integration Guide Template
#8
#9	Integration guides prove a joint journey: configure Mem0 and the partner with minimal steps, run one end-to-end sanity command, then hand the reader to deeper workflows.
#10
#11	---
#12
#13	## ❌ DO NOT COPY — Guidance & Constraints
#14	- Frontmatter must include `title`, `description`, `icon`, and optional `partnerBadge`/`tags`. State the joint value in one sentence right after the H1.
#15	- List prerequisites for both platforms inside an `<Info>` block. Surface limited-access or beta flags in a `<Warning>` before any setup.
#16	- Default to Tabs + Steps when instructions diverge (Platform vs OSS, Python vs TypeScript). When only one path exists, add a `<Note>` explaining the missing variant.
#17	- When migrating an existing integration, keep the proven steps/screenshots—map them into this structure rather than rewriting unless either product has changed.
#18	- Keep any Mermaid diagrams optional and left-to-right (`graph LR`) to avoid vertical overflow; use only if architecture clarity is needed.
#19	- Every major step must finish with a verification `<Info icon="check">`. End the page with exactly two CTA cards (left = related reference, right = next integration/cookbook).
#20
#21	---
#22
#23	## ✅ COPY THIS — Content Skeleton
#24	Paste the block below, replace placeholders, and delete optional sections only when unnecessary for this integration.
#25
#26	````mdx
#27	---
#28	title: [Integration title]
#29	description: [One-sentence joint value]
#30	icon: "puzzle-piece"
#31	partnerBadge: "[Partner name]" # Optional
#32	---
#33
#34	# [Integration headline — Mem0 + Partner promise]
#35
#36	Combine Mem0’s memory layer with [Partner] to [describe the joint outcome].
#37
#38	<Info>
#39	Prerequisites
#40	- [Mem0 requirement: API key, SDK version, project access]
#41	- [Partner requirement: account, SDK version, tooling]
#42	- [Optional extras: Docker, ngrok, etc.]
#43	</Info>
#44
#45	<Warning>
#46	[Use only if access is gated or breaking changes exist. Delete when not needed.]
#47	</Warning>
#48
#49	{/* Optional architecture diagram */}
#50	```mermaid
#51	graph LR
#52	A[Mem0] */} B[Connector]
#53	B */} C[Partner workflow]
#54	```
#55
#56	## Configure credentials
#57
#58	<Tabs>
#59	<Tab title="Mem0">
#60	<Steps>
#61	<Step title="Create or locate your API key">
#62	```bash
#63	export MEM0_API_KEY="sk-..."
#64	```
#65	</Step>
#66	<Step title="Store it where the integration expects it">
#67	```bash
#68	partner secrets set MEM0_API_KEY=$MEM0_API_KEY
#69	```
#70	</Step>
#71	</Steps>
#72	</Tab>
#73	<Tab title="[Partner]">
#74	<Steps>
#75	<Step title="Generate partner credentials">
#76	```bash
#77	partner auth login
#78	```
#79	</Step>
#80	<Step title="Expose them to your runtime">
#81	```bash
#82	export PARTNER_API_KEY="..."
#83	```
#84	</Step>
#85	</Steps>
#86	</Tab>
#87	</Tabs>
#88
#89	<Tip>
#90	Self-hosting Mem0? Swap `https://api.mem0.ai` with `https://<your-domain>` and keep the rest of this guide identical.
#91	</Tip>
#92
#93	## Wire Mem0 into [Partner]
#94
#95	<Tabs>
#96	<Tab title="Python">
#97	<Steps>
#98	<Step title="Install SDKs">
#99	```bash
#100	pip install mem0ai [partner-package]
#101	```
#102	</Step>
#103	<Step title="Initialize clients">
#104	```python
#105	from mem0 import Memory
#106	from partner import Client
#107
#108	memory = Memory(api_key=os.environ["MEM0_API_KEY"])
#109	partner_client = Client(api_key=os.environ["PARTNER_API_KEY"])
#110	```
#111	</Step>
#112	<Step title="Register Mem0 inside the partner workflow">
#113	```python
#114	@graph.tool
#115	def recall_preferences(user_id: str):
#116	return memory.search("recent preferences", filters={"user_id": user_id})
#117	```
#118	</Step>
#119	</Steps>
#120	</Tab>
#121	<Tab title="TypeScript">
#122	<Steps>
#123	<Step title="Install SDKs">
#124	```bash
#125	npm install mem0ai [partner-package]
#126	```
#127	</Step>
#128	<Step title="Initialize clients">
#129	```typescript
#130	import { Memory } from "mem0ai/oss";
#131	import { Partner } from "[partner-package]";
#132
#133	const memory = new Memory({ apiKey: process.env.MEM0_API_KEY! });
#134	const partner = new Partner({ apiKey: process.env.PARTNER_API_KEY! });
#135	```
#136	</Step>
#137	<Step title="Register Mem0 inside the partner workflow">
#138	```typescript
#139	partner.registerTool("recallPreferences", async (userId: string) => {
#140	const result = await memory.search("recent preferences", { userId });
#141	return result.results;
#142	});
#143	```
#144	</Step>
#145	</Steps>
#146	</Tab>
#147	</Tabs>
#148
#149	<Info icon="check">
#150	Run `[verification command]` and expect `[describe log/result]`. If you see `[common error]`, jump to Troubleshooting below.
#151	</Info>
#152
#153	## Run the integration sanity check
#154
#155	```bash
#156	[command or script that exercises the flow]
#157	```
#158
#159	<Info icon="check">
#160	Output should mention `[success signal]` and `[partner console confirmation]`.
#161	</Info>
#162
#163	## Verify the integration
#164
#165	- `[Signal 1: dashboard entry, log line, or console message]`
#166	- `[Signal 2: partner UI reflects the memory data]`
#167	- `[Optional signal 3]`
#168
#169	## Troubleshooting
#170
#171	- [Issue] — `[Fix or link to partner docs]`
#172	- [Issue] — `[Fix or link to Mem0 troubleshooting guide]`
#173
#174	{/* DEBUG: verify CTA targets */}
#175
#176	<CardGroup cols={2}>
#177	<Card
#178	title="[Related Mem0 feature]"
#179	description="[Why this feature enhances the integration]"
#180	icon="sparkles"
#181	href="/[reference-link]"
#182	/>
#183	<Card
#184	title="[Next integration or cookbook]"
#185	description="[What they can build next]"
#186	icon="rocket"
#187	href="/[next-link]"
#188	/>
#189	</CardGroup>
#190	````
#191
#192	---
#193
#194	## ✅ Publish Checklist
#195	- [ ] Joint value statement and prerequisites cover both Mem0 and partner requirements.
#196	- [ ] Tabs/Steps include Python and TypeScript (or a `<Note>` explains missing parity).
#197	- [ ] Every major step ends with an `<Info icon="check">` describing success criteria.
#198	- [ ] Troubleshooting lists at least two concrete fixes.
#199	- [ ] Final `<CardGroup>` has exactly two cards with validated links.
#200
#201	## Browse Other Templates
#202
#203	<CardGroup cols={3}>
#204	<Card
#205	title="Quickstart"
#206	description="Install → Configure → Add → Search → Delete."
#207	icon="rocket"
#208	href="/templates/quickstart_template"
#209	/>
#210	<Card
#211	title="Operation Guide"
#212	description="Single task walkthrough with verification checkpoints."
#213	icon="circle-check"
#214	href="/templates/operation_guide_template"
#215	/>
#216	<Card
#217	title="Feature Guide"
#218	description="Explain when and why to use a capability, not just the API."
#219	icon="sparkles"
#220	href="/templates/feature_guide_template"
#221	/>
#222	<Card
#223	title="Concept Guide"
#224	description="Define mental models, key terms, and diagrams."
#225	icon="brain"
#226	href="/templates/concept_guide_template"
#227	/>
#228	<Card
#229	title="Integration Guide"
#230	description="Configure Mem0 alongside third-party tools."
#231	icon="plug"
#232	href="/templates/integration_guide_template"
#233	/>
#234	<Card
#235	title="Cookbook"
#236	description="Narrative, end-to-end walkthroughs."
#237	icon="book-open"
#238	href="/templates/cookbook_template"
#239	/>
#240	<Card
#241	title="API Reference"
#242	description="Endpoint specifics with dual-language examples."
#243	icon="code"
#244	href="/templates/api_reference_template"
#245	/>
#246	<Card
#247	title="Parameters Reference"
#248	description="Accepted fields, defaults, and misuse fixes."
#249	icon="list"
#250	href="/templates/parameters_reference_template"
#251	/>
#252	<Card
#253	title="Migration Guide"
#254	description="Plan → migrate → validate with rollback."
#255	icon="arrow-right"
#256	href="/templates/migration_guide_template"
#257	/>
#258	<Card
#259	title="Release Notes"
#260	description="Ship highlights and required CTAs."
#261	icon="megaphone"
#262	href="/templates/release_notes_template"
#263	/>
#264	<Card
#265	title="Troubleshooting Playbook"
#266	description="Symptom → diagnose → fix."
#267	icon="life-buoy"
#268	href="/templates/troubleshooting_playbook_template"
#269	/>
#270	<Card
#271	title="Section Overview"
#272	description="Landing pages with card grids and CTA pair."
#273	icon="grid"
#274	href="/templates/section_overview_template"
#275	/>
#276	</CardGroup>
#277
#278	<CardGroup cols={2}>
#279	<Card
#280	title="Contribution Hub"
#281	description="Review the authoring workflow and linked templates."
#282	icon="clipboard-list"
#283	href="/platform/contribute"
#284	/>
#285	<Card
#286	title="Docs Home"
#287	description="Return to the platform overview once you’re done."
#288	icon="compass"
#289	href="/platform/overview"
#290	/>
#291	</CardGroup>
#292

z6Mkq5mY3JWtxoxUobWcfNHm7AkRubgSWEZTkBVqZXJviFZ5/my-project-public