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

πŸ”‘ Authentication

The Python SDK supports dual authentication:

  • api_key
  • jwt_token

Use one of them in ClientOptions or mate.yaml.

1. Get Credentials

  1. Sign in to mate.wyseos.com
  2. Open your dashboard
  3. Create an API key, or use your JWT token from your auth flow

2. Configure with mate.yaml (Recommended)

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 it:

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

client = Client(load_config("mate.yaml"))

3. Configure in Code

from wyseos.mate import Client, ClientOptions

# API key
client = Client(ClientOptions(api_key="YOUR_API_KEY"))

# JWT token
client = Client(ClientOptions(jwt_token="YOUR_JWT_TOKEN"))

4. Header and Query Mapping

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

5. Notes

  • Keep credentials out of source code in production.
  • Prefer mate.yaml and secret management.

✨ Getting Started

Previous Page

🐍 Examples

Next Page

Table of Contents

1. Get Credentials
2. Configure with mate.yaml (Recommended)
3. Configure in Code
4. Header and Query Mapping
5. Notes