Skip to content

fix: Scheduler docs reference non-existent SDK methods and mismatch the actual server API #2083

Description

@Lilili-04

Pre-submission checklist | 提交前检查

  • I have searched existing issues and this hasn't been mentioned before | 我已搜索现有问题,确认此问题尚未被提及
  • I have read the project documentation and confirmed this issue doesn't already exist | 我已阅读项目文档并确认此问题尚未存在
  • This issue is specific to MemOS and not a general software issue | 该问题是针对 MemOS 的,而不是一般软件问题

Bug Description | 问题描述

The "Quick Start" examples in two docs under docs/cn/open_source/open_source_api/scheduler/ call MemOSClient methods that do not exist in the SDK (src/memos/api/client.py). Running the documented code raises AttributeError / TypeError.

Affected files:

  • docs/cn/open_source/open_source_api/scheduler/get_status.md
  • docs/cn/open_source/open_source_api/scheduler/ wait.md (note: the filename contains a leading space; suggest renaming it to wait.md as well)

How to Reproduce | 如何重现

  1. Copy the "Quick Start" example from docs/cn/open_source/open_source_api/scheduler/get_status.md and run it:

    from memos.api.client import MemOSClient
    
    client = MemOSClient(api_key="...", base_url="...")
    client.get_all_scheduler_status()
    
    client.get_task_queue_status(user_id="dev_user_01")
    
    client.get_task_status(user_id="dev_user_01", task_id="task_888999")
  2. Copy the "Quick Start" example from docs/cn/open_source/open_source_api/scheduler/ wait.md and run it:

    client.wait_until_idle(user_name="dev_user_01", timeout_seconds=300, poll_interval=2)
    
    client.stream_scheduler_progress(user_name="dev_user_01", timeout_seconds=300)
  3. Verify against the source: grep "def " src/memos/api/client.py shows none of these methods exist, and get_task_status (src/memos/api/client.py, around line 420) only accepts task_id.

Environment | 环境信息

  • OS: any (doc/code mismatch, not platform-specific)
  • Python: any version supported by the project

Additional Context | 其他信息

No response

Willingness to Implement | 实现意愿

  • I'm willing to implement this myself | 我愿意自己解决
  • I would like someone else to implement this | 我希望其他人来解决

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:docs文档、示例status:in-progressSomeone or AI is working on it | 人工或 AI 正在处理

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions