Skip to content

README.md

Latest commit

 

History

History
160 lines (112 loc) · 5.54 KB

README.md

File metadata and controls

160 lines (112 loc) · 5.54 KB
Maybind Logo

Python License Build API Docs

Official SDK for Maybind Digital Twin Platform
Build and interact with AI digital twins through our comprehensive API

Maybind lets anyone create a personalized Digital Twin through a short conversation, and unlocks meaningful, simulation-driven experiences while enabling developers to build and share Twin-powered services within a privacy-first platform.

Core Features

✅ Available Now

  • ⚡ Rapid Setup - Get started with setup_quick.py in under 5 minutes
  • 🤖 AI Agent Chat - Conversational agents that simulate user behaviors (powered by Google Gemini)
  • Production-Ready - API key authentication, usage tracking, enterprise reliability
  • Agent Discovery - Automatic detection and selection of available AI agents
  • Python SDK - Complete SDK with examples, tests, and documentation

🚧 Coming Soon

  • JavaScript/Node.js SDK - Full-featured web and Node.js support
  • Go SDK - High-performance SDK for Go developers
  • Custom Agent Training - Train agents to simulate specific user behaviors
  • Marketplace Integration - Publish and monetize your agent-based services

Project Structure

maybind-sdk/
├── 📄 README.md               # Overview and quick start
├── 📁 openapi/               # API specifications  
├── 📁 scripts/               # Development tools
└── 📁 sdk/                   # Multi-language SDKs
    └── python/               # 🐍 Python SDK
        ├── 📄 README.md      # Complete Python guide
        ├── 📄 setup_quick.py  # Interactive setup
        ├── 📁 examples/      # Working examples
        └── 📁 tests/         # Test suite

Getting Started

Ready to build with AI twins? Get your API key and jump to Quick Start ⬇️

Usage Preview

# Chat with an AI twin in 3 lines
api = DefaultApi()  # Auto-configured with .env
response = api.chat_chat_post(ChatRequest(twin_id="01", messages=[...]))
print(response.messages[-1]['text'])  # Twin's response

Authentication

Get your API key from Maybind Developer Dashboard:

# Set your API key
export MAYBIND_API_KEY="your_api_key_here"

Installation

Quick Start

Python SDK

# 1. Clone and setup
git clone https://github.com/Maybind/maybind-sdk.git
cd maybind-sdk/sdk/python

# 2. Run quick setup (interactive configuration)
python setup_quick.py

# 3. Test with examples
python examples/example_chat.py

The setup_quick.py script will:

  • ✅ Install dependencies automatically
  • ✅ Create .env configuration file
  • ✅ Verify your API key with usage stats
  • ✅ Test the connection

📖 Complete Python guide: sdk/python/README.md

SDK Documentation

Language Status Documentation Examples
Python ✅ Ready sdk/python/README.md examples/
JavaScript 🚧 Coming Soon - -
Go 🚧 Coming Soon - -

📘 Full API reference (Swagger): https://maybind.github.io/maybind-sdk/swagger/

🤝 Contributing

We welcome contributions! Here's how to get started:

  1. Fork the repository - Click "Fork" on GitHub to create your copy
  2. Create feature branch - git checkout -b feature/your-feature-name
  3. Commit changes - git commit -m 'Add: your feature description'
  4. Push branch - git push origin feature/your-feature-name
  5. Open Pull Request - Go to GitHub and click "Compare & pull request"

Branch examples: feature/javascript-sdk, bugfix/api-timeout, docs/quickstart-guide

Generate SDK

./scripts/generate_sdk.sh     # Unix/Linux/macOS
scripts\generate_sdk.bat      # Windows

API Specification

OpenAPI spec: openapi/maybind-api.yaml

📋 Requirements

📈 Roadmap

  • v1.0 ✅ Python SDK with chat and twin management
  • v1.1 🚧 JavaScript/Node.js SDK
  • v1.2 🚧 Go SDK
  • v2.0 🚧 Advanced twin customization features

🆘 Support

📄 License

MIT License - see LICENSE file for details.

🌟 Star us on GitHub | 🌐 Visit Maybind.com

Building the future of digital twins 🤖✨