WyseOS
首页Python SDK用户手册
WyseOS

Introduction

📖 文档📜 核心概念

Users

📋 用户手册

Developers

🚀 Python SDK
📋 安装指南✨ 快速开始🔑 身份验证🐍 示例⚙️ 发布说明🔌 API 参考🔧 故障排除

Changelogs

Others

联系我们
🚀 Python SDK

📋 安装指南

安装并配置 WyseOS Python SDK,以使用最新会话协议。

环境要求

  • Python 3.9+
  • macOS、Linux 或 Windows

从 PyPI 安装

pip install wyseos-sdk

从源码安装

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

激活虚拟环境:

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

安装依赖并安装本地包:

pip install -e .

基础验证

from wyseos.mate import Client, ClientOptions

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

配置

创建 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

加载配置:

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"))

认证说明

  • HTTP:
    • api_key -> x-api-key
    • jwt_token -> Authorization(不带 Bearer 前缀)
  • WebSocket:
    • API Key query: ?api_key=...
    • JWT query: ?authorization=...

下一步

  • 快速开始
  • 示例
  • API 参考

🚀 Introduction

上一页

✨ 快速开始

下一页

目录

环境要求
从 PyPI 安装
从源码安装
基础验证
配置
认证说明
下一步