WyseOS
HomepagePython SDKUser Manual
WyseOS

Introduction

πŸ“– DocumentationπŸ“œ Concepts

Users

πŸ“‹ User Manual

Developers

πŸš€ Python SDK
πŸ“‹ Installation✨ Getting StartedπŸ”‘ Authentication🐍 Examplesβš™οΈ Release NotesπŸ”Œ ReferencesπŸ”§ Troubleshooting

Changelogs

Others

Contact Us
πŸš€ Python SDK

βš™οΈ Release Notes

πŸš€ Release 0.3.1 (2026-03-31)

✨ Major Features

  • πŸ“¦ Product Analysis Service: New ProductService for the full product analysis lifecycle β€” create, poll, and retrieve reports via REST API (no WebSocket needed).
    • client.product.create() β€” submit product name or URL with optional attachments
    • client.product.get_info() β€” poll product generation status
    • client.product.get_report() β€” get full analysis report (keywords, personas, competitors, campaigns)
    • client.product.get_categories() β€” retrieve industry classification data
    • client.product.create_and_wait() β€” high-level method that handles the entire create β†’ poll β†’ report flow with callback support
  • πŸ“Š Product Data Models: Typed Pydantic models for the product API: CreateProductRequest, CreateProductResponse, ProductInfo, ProductReport, Campaign, IndustryCondition, Category, Industry

πŸ”§ Improvements

  • πŸ”‡ Cleaner Logging: WebSocket connection URL (containing credentials) moved from INFO to DEBUG; disconnect internals also demoted to DEBUG
  • πŸ“‹ Better CLI Output: Plan status updates now use [plan] status: xxx format; task result shows [task_result] completed/stopped; JSON completion messages parsed to display human-readable reason instead of truncated raw JSON
  • πŸ›‘οΈ Example Robustness: Both examples now exit cleanly with a helpful message when mate.yaml is missing or has invalid credentials, instead of falling back to empty defaults

πŸ“ New Files

  • wyseos/mate/services/product.py β€” ProductService implementation
  • examples/product_analysis/example.py β€” standalone product analysis example
  • docs/api-product-create.md β€” product API documentation (Chinese)

πŸ“¦ See: wyseos-sdk 0.3.1 on PyPI

πŸš€ Release 0.3.0 (2026-03-31)

✨ Major Features

  • 🎯 Marketing Mode: Full marketing support β€” product analysis, trending topic selection, tweet/thread generation, and rich streaming with chunk aggregation.
    • New TaskMode.Marketing for marketing-specific session execution
    • New MarketingService with REST APIs: get_product_info, get_report_detail, update_report, get_research_tweets
    • New SessionService.get_marketing_data() for retrieving generated content (reply/like/retweet/tweet) per session
    • Rich streaming support for writer_twitter, marketing_tweet_reply, marketing_tweet_interact
  • πŸ”‘ JWT Authentication: Dual auth support β€” API key and JWT token, across both HTTP and WebSocket.
  • πŸ›‘ CLI Safe Mode: stop_on_x_confirm option to prevent browser actions in headless/CLI environments.
  • ⏸️ Session Pause: New send_pause() for pausing active sessions.

πŸ”§ Improvements

  • πŸ“¦ TaskRunner Refactor: Extracted TaskRunner, TaskExecutionOptions, TaskResult, and TaskMode out of websocket.py into dedicated task_runner.py (~500 lines reduction in websocket module).
  • πŸ”‡ Cleaner CLI Output: Debug logs moved from INFO to DEBUG level; verbose output uses consistent [plan]/[text]/[task_result] prefixes; JSON completion messages parsed to show human-readable reason.
  • πŸ“‹ Session Protocol Alignment: CreateSessionRequest simplified (removed team_id, added mode/platform/extra); SessionInfo fields made lenient with sensible defaults.
  • 🏭 Factory Function: create_task_runner() exposed at package level for clean initialization.

πŸ› Bug Fixes

  • Fixed auto_accept_plan not working in run_interactive_session
  • Fixed session not stopping after receiving final answer
  • Fixed screenshot printing to omit large base64 data

πŸ’₯ Breaking Changes

  • CreateSessionRequest no longer requires team_id
  • Session status constants renamed: SESSION_STATUS_RUNNING β†’ SESSION_STATUS_ACTIVE
  • Plan status SKIPPED renamed to SKIP

πŸ“¦ See: wyseos-sdk 0.3.0 on PyPI

πŸš€ Release 0.2.1 (2025-09-11)

✨ Major Features

  • 🎯 New: TaskRunner Interface: Simplified task execution interface that reduces complex WebSocket operations from 400+ lines to 10-20 lines of clean code.
    • run_task() - Automated execution with comprehensive results
    • run_interactive_session() - Interactive mode with user input support
  • βš™οΈ New: TaskExecutionOptions: Advanced configuration system with intelligent defaults including performance-optimized screenshot capture (capture_screenshots=False by default).
  • πŸ“Š New: Enhanced Result Tracking: Complete TaskResult model with execution duration, message counts, plan history, and structured error reporting.

πŸ”§ Improvements

  • πŸ“¦ Refactored Message Handling: Modular message processing with dedicated handlers for text, plan, rich media, and input messages.
  • πŸ“š Enhanced Documentation: Complete rewrite of quickstart guide and README with modern examples and clear API documentation.
  • ⚑ Performance Optimizations: Default settings optimized for speed with conditional data collection and reduced memory usage.
  • πŸ›‘οΈ Improved Error Handling: Enhanced exception management with detailed error context and graceful resource cleanup.

πŸ› Bug Fixes

  • 🧡 Enhanced Thread Safety: Improved thread-safe completion event handling for concurrent operations.
  • πŸ”Œ Connection Management: Better WebSocket connection lifecycle management with proper cleanup.

πŸ“¦ See: wyseos-sdk 0.2.1 on PyPI

πŸ“¦ Release 0.2.0 (2025-08-25)

πŸ’₯ Breaking Changes

  • 🏷️ Project Renamed: The SDK has been renamed from wyse-mate-sdk to wyseos-sdk. All module imports must be updated from wyse_mate to wyseos.mate.
    • Before: from wyse_mate import Client
    • After: from wyseos.mate import Client

πŸ”§ Improvements

  • πŸ—οΈ Project Restructuring: Aligned project with the WyseOS and established a new, extensible namespace wyseos for future tools.
  • βš™οΈ Simplified Configuration: Removed user_agent, debug, and http_client from the configuration options for a cleaner setup.
  • πŸ“š Added Examples: Introduced a new examples directory with a getting_started guide to improve user onboarding.

πŸ› Bug Fixes

  • 🚫 Fixed ImportError: Resolved an ImportError for DEFAULT_USER_AGENT that occurred after simplifying the configuration.
  • βœ… Fixed ValidationError: Addressed a ValidationError by making the intent_id field in the SessionInfo model optional to handle missing fields in the API response.

πŸ“¦ See: wyseos-sdk 0.2.0 on PyPI

πŸ“¦ Release 0.1.2 (2025-08-08)

πŸ”§ Improvements

  • πŸ†• New: Plan messages with overall status tracking
  • πŸ†• New: Expanded WebSocket interactions and stability
  • πŸ“ˆ Improvement: Clearer usage in examples

πŸ“¦ See: wyse-mate-sdk 0.1.2

πŸ“ Commits

  • 6d52b80 β€” release version 0.1.2
  • dda05b0 β€” add plan overall status
  • bcec77d β€” add message type Plan
  • 09c20ad β€” update example
  • 77fe5b3 β€” update example
  • fb6fef6 β€” support more websocket interactions

πŸ‘₯ Come Hang Out

  • πŸ› Found a bug? Open an issue on Github

🐍 Examples

Previous Page

πŸ”Œ References

Next Page

Table of Contents

πŸš€ Release 0.3.1 (2026-03-31)
✨ Major Features
πŸ”§ Improvements
πŸ“ New Files
πŸš€ Release 0.3.0 (2026-03-31)
✨ Major Features
πŸ”§ Improvements
πŸ› Bug Fixes
πŸ’₯ Breaking Changes
πŸš€ Release 0.2.1 (2025-09-11)
✨ Major Features
πŸ”§ Improvements
πŸ› Bug Fixes
πŸ“¦ Release 0.2.0 (2025-08-25)
πŸ’₯ Breaking Changes
πŸ”§ Improvements
πŸ› Bug Fixes
πŸ“¦ Release 0.1.2 (2025-08-08)
πŸ”§ Improvements
πŸ“ Commits
πŸ‘₯ Come Hang Out