docs: fix OSS REST API endpoint discrepancies#4555
Merged
whysosaket merged 1 commit intomainfrom Mar 26, 2026
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
kartik-mem0
approved these changes
Mar 26, 2026
whysosaket
approved these changes
Mar 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #4445
Related to #2680
Summary
Fixes the documentation discrepancy reported in #4445 (also related to #2680) where users deploying the self-hosted OSS server encounter incorrect API endpoint paths in the docs.
Problems found
Missing clarification between OSS and Platform APIs: The API Reference documents the hosted platform at
api.mem0.aiwhich uses/v1/prefixed paths (e.g.,POST /v1/memories/). The OSS server inserver/main.pydoes not use the/v1/prefix (e.g.,POST /memories). There was no callout explaining this distinction, leading users to try/v1/paths on their self-hosted server and get 404s.Incorrect search endpoint in examples: The search example showed
GET /memories/search?user_id=alice&query=vegetable, but the actual implementation isPOST /searchwith a JSON body. Both the path and HTTP method were wrong.No endpoint reference table: OSS users had no authoritative list of available endpoints and had to read the source code or navigate to
/docson a running server.Solution
/v1/) from platform pathsPOST /searchwith a JSON request body, matching theSearchRequestmodel inserver/main.pyPOST /memories/searchtoPOST /searchserver/main.pyTest plan
server/main.pySearchRequestPydantic model andPOST /searchroute🤖 Generated with Claude Code