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

πŸ“‹ Installation

Install and configure the WyseOS Python SDK for the latest session protocol.

Requirements

  • Python 3.9+
  • macOS, Linux, or Windows

Install from PyPI

pip install wyseos-sdk

Install from Source

git clone https://github.com/WyseOS/wyseos-sdk-python
cd wyseos-sdk-python
python -m venv .venv

Activate the virtual environment:

  • macOS/Linux:
source .venv/bin/activate
  • Windows (PowerShell):
.\.venv\Scripts\Activate.ps1

Install dependencies and the local package:

pip install -e .

Basic Verification

from wyseos.mate import Client, ClientOptions

client = Client(ClientOptions(api_key="your-api-key"))
print("SDK loaded, base_url:", client.base_url)

Configuration

Create mate.yaml:

mate:
  # Use one of api_key or jwt_token
  api_key: "your-api-key"
  # jwt_token: "your-jwt-token"

  base_url: "https://api.wyseos.com"
  timeout: 30

Load config:

from wyseos.mate import Client, ClientOptions
from wyseos.mate.config import load_config

try:
    client = Client(load_config("mate.yaml"))
except Exception:
    client = Client(ClientOptions(api_key="your-api-key"))

Authentication Notes

  • HTTP:
    • api_key -> x-api-key
    • jwt_token -> Authorization (no Bearer prefix)
  • WebSocket:
    • API Key query: ?api_key=...
    • JWT query: ?authorization=...

Next

  • Getting Started
  • Examples
  • References

πŸš€ Introduction

Previous Page

✨ Getting Started

Next Page

Table of Contents

Requirements
Install from PyPI
Install from Source
Basic Verification
Configuration
Authentication Notes
Next