Skip to content

docs: fix OSS REST API endpoint discrepancies#4555

Merged
whysosaket merged 1 commit intomainfrom
fix/docs-api-prefix
Mar 26, 2026
Merged

docs: fix OSS REST API endpoint discrepancies#4555
whysosaket merged 1 commit intomainfrom
fix/docs-api-prefix

Conversation

@utkarsh240799
Copy link
Copy Markdown
Contributor

@utkarsh240799 utkarsh240799 commented Mar 26, 2026

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

  1. Missing clarification between OSS and Platform APIs: The API Reference documents the hosted platform at api.mem0.ai which uses /v1/ prefixed paths (e.g., POST /v1/memories/). The OSS server in server/main.py does 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.

  2. Incorrect search endpoint in examples: The search example showed GET /memories/search?user_id=alice&query=vegetable, but the actual implementation is POST /search with a JSON body. Both the path and HTTP method were wrong.

  3. No endpoint reference table: OSS users had no authoritative list of available endpoints and had to read the source code or navigate to /docs on a running server.

Solution

  • Added a warning callout at the top of the OSS REST API docs clearly distinguishing OSS paths (no /v1/) from platform paths
  • Fixed the search curl example to use POST /search with a JSON request body, matching the SearchRequest model in server/main.py
  • Fixed the OpenAPI docs reference from POST /memories/search to POST /search
  • Added a complete endpoint reference table listing all 10 API endpoints with correct methods and paths, verified against server/main.py

Test plan

  • Verify all 10 endpoints in the reference table match the routes defined in server/main.py
  • Confirm the search curl example matches the SearchRequest Pydantic model and POST /search route
  • Check the docs use valid Mintlify syntax (warning callout, markdown table) consistent with sibling docs

🤖 Generated with Claude Code

The OSS REST API docs had incorrect endpoint paths that didn't match
the actual server implementation, causing confusion for self-hosted
users (fixes #4445, related #2680).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@mintlify
Copy link
Copy Markdown
Contributor

mintlify bot commented Mar 26, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mem0 🟢 Ready View Preview Mar 26, 2026, 11:50 AM

@whysosaket whysosaket merged commit 515f87b into main Mar 26, 2026
4 checks passed
@whysosaket whysosaket deleted the fix/docs-api-prefix branch March 26, 2026 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DOC: Documentation Discrepancy: Inconsistent /v1/ Prefix in API Endpoints

3 participants