superu


Namesuperu JSON
Version 2025.7.9.2 PyPI version JSON
download
home_pageNone
SummarySuperU SDK to make AI calls - Create intelligent voice assistants for automated phone calls
upload_time2025-07-09 08:25:24
maintainerNone
docs_urlNone
authorNone
requires_python>=3.7
licenseMIT
keywords ai voice assistant phone calls automation superu sdk
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # SuperU - AI Voice Assistant Platform

[![PyPI version](https://img.shields.io/pypi/v/superu.svg)](https://pypi.org/project/superu/)
[![Python 3.7+](https://img.shields.io/badge/python-3.7+-blue.svg)](https://www.python.org/downloads/)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)

SuperU is a powerful Python SDK for creating AI-powered voice assistants that can make automated phone calls, handle customer interactions, and integrate with your existing APIs and tools.

## 🚀 Features

- **AI Voice Assistants**: Create intelligent voice agents with custom personalities
- **Automated Phone Calls**: Make outbound calls with AI assistants
- **Multi-language Support**: Hindi, English (Indian, American, British accents), and more
- **Tool Integration**: Connect your APIs for dynamic data retrieval during calls
- **Call Analytics**: Comprehensive analysis and transcription of all interactions
- **Flexible Configuration**: Support for multiple AI models, transcribers, and voice providers

## 📦 Installation

```bash
pip install superu
```

## 🔑 Getting Started

### 1. Get Your API Key

1. Visit [dev.superu.ai](https://dev.superu.ai/) and sign up
2. Go to your dashboard
3. Copy your API key

### 2. Basic Usage

```python
import superu

# Initialize the client
client = superu.SuperU('your_api_key_here')

# Create a basic assistant
assistant = client.assistants.create_basic(
    name="Customer Service Assistant",
    voice_id="90ipbRoKi4CpHXvKVtl0",  # Anika - Indian English
    first_message="Hello! How can I help you today?",
    system_prompt="You are a helpful customer service representative."
)

# Make a phone call
call = client.calls.create(
    from_='918035737904',  # Your SuperU number
    to_='+919876543210',   # Customer's number
    assistant_id=assistant['id'],
    max_duration_seconds=300
)

print(f"Call initiated: {call['call_uuid']}")
```

## 🎯 Advanced Usage

### Creating an Advanced Assistant

```python
# Advanced assistant with custom configuration
advanced_config = {
    "name": "Sales Assistant",
    "voice": {
        "model": "eleven_flash_v2_5",
        "voiceId": "xnx6sPTtvU635ocDt2j7",  # Chinmay - Indian English Male
        "provider": "11labs",
        "stability": 0.9,
        "similarityBoost": 0.9,
        "useSpeakerBoost": True
    },
    "model": {
        "model": "gpt-4o-mini",
        "provider": "openai",
        "temperature": 0.7,
        "messages": [
            {
                "role": "system",
                "content": "You are a professional sales representative..."
            }
        ]
    },
    "transcriber": {
        "model": "nova-2",
        "language": "en",
        "provider": "deepgram",
        "endpointing": 300
    },
    "firstMessage": "Hi! I'm calling to discuss our latest offers.",
    "endCallMessage": "Thank you for your time. Have a great day!"
}

assistant = client.assistants.create(**advanced_config)
```

### Available Voices

| Voice ID | Language | Gender | Accent | Name |
|----------|----------|---------|---------|------|
| `gHu9GtaHOXcSqFTK06ux` | Hindi | Female | Standard | Anjali - Soothing Hindi Voice |
| `m5qndnI7u4OAdXhH0Mr5` | Hindi | Male | Standard | Krishna - Energetic Hindi Voice |
| `90ipbRoKi4CpHXvKVtl0` | English | Female | Indian | Anika - Customer Care Agent |
| `xnx6sPTtvU635ocDt2j7` | English | Male | Indian | Chinmay - Calm & Energetic |
| `kdmDKE6EkgrWrrykO9Qt` | English | Female | American | Alexandra |
| `XA2bIQ92TabjGbpO2xRr` | English | Male | American | Jerry |
| `MzqUf1HbJ8UmQ0wUsx2p` | English | Female | British | Katie X |
| `qxjGnozOAtD4eqNuXms4` | English | Male | British | John Shaw - Customer Care |

### Creating Custom Tools

Enable your assistant to call your APIs during conversations:

```python
# Create a tool for checking user information
tool = client.tools.create(
    name="check-user-status",
    description="Check if a user exists in our database",
    parameters={
        "type": "object",
        "properties": {
            "email": {
                "type": "string",
                "description": "User's email address"
            }
        },
        "required": ["email"]
    },
    tool_url="/api/check-user",
    tool_url_domain="https://your-api.com",
    async_=False
)

# Use the tool in your assistant
assistant_config["model"]["toolIds"] = [tool['id']]
```

### Call Analysis

```python
# Get call analysis
call_uuid = call['call_uuid']
analysis = client.calls.analysis(call_uuid)

print(f"Call duration: {analysis['duration']}")
print(f"Transcript: {analysis['transcript']}")
print(f"Sentiment: {analysis['sentiment']}")
```

### Twilio Integration

```python
# Use your own Twilio number
call = client.calls.create_twilio_call(
    phoneNumberId="your_twilio_number_id",
    to_="+919876543210",
    assistant_id=assistant['id']
)

# Analyze Twilio calls
analysis = client.calls.analysis_twilio_call(call['call_uuid'])
```

## 🛠️ Configuration Options

### Transcriber Options

- **Deepgram**: High-quality, fast transcription with multilingual support
- **AssemblyAI**: Advanced transcription with sentiment analysis
- **Azure**: Microsoft's speech-to-text service
- **11Labs**: ElevenLabs transcription service

### AI Models

- **OpenAI**: GPT-4o, GPT-4, GPT-3.5-turbo with customizable temperature and tools
- Support for custom knowledge bases and function calling

### Voice Providers

- **ElevenLabs**: Premium voice synthesis with multiple models and languages
- Customizable stability, similarity boost, and speaker enhancement

## 📊 Use Cases

- **Customer Service**: Automated support calls with intelligent responses
- **Sales Outreach**: Personalized sales calls with lead qualification
- **Appointment Booking**: Automated scheduling and reminders
- **Survey Collection**: Interactive voice surveys with data collection
- **Lead Qualification**: Intelligent lead scoring and follow-up
- **Order Status**: Automated order updates and delivery notifications

## 🔧 API Reference

### Core Methods

```python
# Client initialization
client = superu.SuperU(api_key)

# Assistants
client.assistants.create_basic(**params)
client.assistants.create(**params)

# Calls
client.calls.create(**params)
client.calls.create_twilio_call(**params)
client.calls.analysis(call_uuid)
client.calls.analysis_twilio_call(call_uuid)

# Tools
client.tools.create(**params)
```

### Call Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `from_` | str | Yes | Caller ID (international format) |
| `to_` | str | Yes | Recipient number (international format) |
| `assistant_id` | str | Yes | Assistant ID to handle the call |
| `max_duration_seconds` | int | No | Maximum call duration (default: 180) |
| `first_message_url` | str | No | URL to initial audio message |

## 🤝 Support

- **Documentation**: [dev.superu.ai](https://dev.superu.ai/)
- **Issues**: Report bugs and feature requests on GitHub
- **Email**: Contact support for enterprise solutions

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## 🚀 Getting Help

```python
# Example: Complete workflow
import superu
import time

# Initialize
client = superu.SuperU('your_api_key')

# Create assistant
assistant = client.assistants.create_basic(
    name="Demo Assistant",
    voice_id="90ipbRoKi4CpHXvKVtl0",
    first_message="Hello! This is a demo call.",
    system_prompt="You are a friendly demo assistant."
)

# Make call
call = client.calls.create(
    from_='your_superu_number',
    to_='+919876543210',
    assistant_id=assistant['id']
)

# Wait for call completion
time.sleep(30)

# Get analysis
analysis = client.calls.analysis(call['call_uuid'])
print("Call completed successfully!")
```

---

**Ready to build intelligent voice applications?** Get started with SuperU today!

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "superu",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "Paras Chhugani <peoband@gmail.com>",
    "keywords": "ai, voice, assistant, phone, calls, automation, superu, sdk",
    "author": null,
    "author_email": "Paras Chhugani <paras@superu.ai>",
    "download_url": "https://files.pythonhosted.org/packages/79/9c/d15f7d9c29f0954ddc937258e1fb679c79175fd65d970b71cd8c0fe32bb8/superu-2025.7.9.2.tar.gz",
    "platform": null,
    "description": "# SuperU - AI Voice Assistant Platform\n\n[![PyPI version](https://img.shields.io/pypi/v/superu.svg)](https://pypi.org/project/superu/)\n[![Python 3.7+](https://img.shields.io/badge/python-3.7+-blue.svg)](https://www.python.org/downloads/)\n[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)\n\nSuperU is a powerful Python SDK for creating AI-powered voice assistants that can make automated phone calls, handle customer interactions, and integrate with your existing APIs and tools.\n\n## \ud83d\ude80 Features\n\n- **AI Voice Assistants**: Create intelligent voice agents with custom personalities\n- **Automated Phone Calls**: Make outbound calls with AI assistants\n- **Multi-language Support**: Hindi, English (Indian, American, British accents), and more\n- **Tool Integration**: Connect your APIs for dynamic data retrieval during calls\n- **Call Analytics**: Comprehensive analysis and transcription of all interactions\n- **Flexible Configuration**: Support for multiple AI models, transcribers, and voice providers\n\n## \ud83d\udce6 Installation\n\n```bash\npip install superu\n```\n\n## \ud83d\udd11 Getting Started\n\n### 1. Get Your API Key\n\n1. Visit [dev.superu.ai](https://dev.superu.ai/) and sign up\n2. Go to your dashboard\n3. Copy your API key\n\n### 2. Basic Usage\n\n```python\nimport superu\n\n# Initialize the client\nclient = superu.SuperU('your_api_key_here')\n\n# Create a basic assistant\nassistant = client.assistants.create_basic(\n    name=\"Customer Service Assistant\",\n    voice_id=\"90ipbRoKi4CpHXvKVtl0\",  # Anika - Indian English\n    first_message=\"Hello! How can I help you today?\",\n    system_prompt=\"You are a helpful customer service representative.\"\n)\n\n# Make a phone call\ncall = client.calls.create(\n    from_='918035737904',  # Your SuperU number\n    to_='+919876543210',   # Customer's number\n    assistant_id=assistant['id'],\n    max_duration_seconds=300\n)\n\nprint(f\"Call initiated: {call['call_uuid']}\")\n```\n\n## \ud83c\udfaf Advanced Usage\n\n### Creating an Advanced Assistant\n\n```python\n# Advanced assistant with custom configuration\nadvanced_config = {\n    \"name\": \"Sales Assistant\",\n    \"voice\": {\n        \"model\": \"eleven_flash_v2_5\",\n        \"voiceId\": \"xnx6sPTtvU635ocDt2j7\",  # Chinmay - Indian English Male\n        \"provider\": \"11labs\",\n        \"stability\": 0.9,\n        \"similarityBoost\": 0.9,\n        \"useSpeakerBoost\": True\n    },\n    \"model\": {\n        \"model\": \"gpt-4o-mini\",\n        \"provider\": \"openai\",\n        \"temperature\": 0.7,\n        \"messages\": [\n            {\n                \"role\": \"system\",\n                \"content\": \"You are a professional sales representative...\"\n            }\n        ]\n    },\n    \"transcriber\": {\n        \"model\": \"nova-2\",\n        \"language\": \"en\",\n        \"provider\": \"deepgram\",\n        \"endpointing\": 300\n    },\n    \"firstMessage\": \"Hi! I'm calling to discuss our latest offers.\",\n    \"endCallMessage\": \"Thank you for your time. Have a great day!\"\n}\n\nassistant = client.assistants.create(**advanced_config)\n```\n\n### Available Voices\n\n| Voice ID | Language | Gender | Accent | Name |\n|----------|----------|---------|---------|------|\n| `gHu9GtaHOXcSqFTK06ux` | Hindi | Female | Standard | Anjali - Soothing Hindi Voice |\n| `m5qndnI7u4OAdXhH0Mr5` | Hindi | Male | Standard | Krishna - Energetic Hindi Voice |\n| `90ipbRoKi4CpHXvKVtl0` | English | Female | Indian | Anika - Customer Care Agent |\n| `xnx6sPTtvU635ocDt2j7` | English | Male | Indian | Chinmay - Calm & Energetic |\n| `kdmDKE6EkgrWrrykO9Qt` | English | Female | American | Alexandra |\n| `XA2bIQ92TabjGbpO2xRr` | English | Male | American | Jerry |\n| `MzqUf1HbJ8UmQ0wUsx2p` | English | Female | British | Katie X |\n| `qxjGnozOAtD4eqNuXms4` | English | Male | British | John Shaw - Customer Care |\n\n### Creating Custom Tools\n\nEnable your assistant to call your APIs during conversations:\n\n```python\n# Create a tool for checking user information\ntool = client.tools.create(\n    name=\"check-user-status\",\n    description=\"Check if a user exists in our database\",\n    parameters={\n        \"type\": \"object\",\n        \"properties\": {\n            \"email\": {\n                \"type\": \"string\",\n                \"description\": \"User's email address\"\n            }\n        },\n        \"required\": [\"email\"]\n    },\n    tool_url=\"/api/check-user\",\n    tool_url_domain=\"https://your-api.com\",\n    async_=False\n)\n\n# Use the tool in your assistant\nassistant_config[\"model\"][\"toolIds\"] = [tool['id']]\n```\n\n### Call Analysis\n\n```python\n# Get call analysis\ncall_uuid = call['call_uuid']\nanalysis = client.calls.analysis(call_uuid)\n\nprint(f\"Call duration: {analysis['duration']}\")\nprint(f\"Transcript: {analysis['transcript']}\")\nprint(f\"Sentiment: {analysis['sentiment']}\")\n```\n\n### Twilio Integration\n\n```python\n# Use your own Twilio number\ncall = client.calls.create_twilio_call(\n    phoneNumberId=\"your_twilio_number_id\",\n    to_=\"+919876543210\",\n    assistant_id=assistant['id']\n)\n\n# Analyze Twilio calls\nanalysis = client.calls.analysis_twilio_call(call['call_uuid'])\n```\n\n## \ud83d\udee0\ufe0f Configuration Options\n\n### Transcriber Options\n\n- **Deepgram**: High-quality, fast transcription with multilingual support\n- **AssemblyAI**: Advanced transcription with sentiment analysis\n- **Azure**: Microsoft's speech-to-text service\n- **11Labs**: ElevenLabs transcription service\n\n### AI Models\n\n- **OpenAI**: GPT-4o, GPT-4, GPT-3.5-turbo with customizable temperature and tools\n- Support for custom knowledge bases and function calling\n\n### Voice Providers\n\n- **ElevenLabs**: Premium voice synthesis with multiple models and languages\n- Customizable stability, similarity boost, and speaker enhancement\n\n## \ud83d\udcca Use Cases\n\n- **Customer Service**: Automated support calls with intelligent responses\n- **Sales Outreach**: Personalized sales calls with lead qualification\n- **Appointment Booking**: Automated scheduling and reminders\n- **Survey Collection**: Interactive voice surveys with data collection\n- **Lead Qualification**: Intelligent lead scoring and follow-up\n- **Order Status**: Automated order updates and delivery notifications\n\n## \ud83d\udd27 API Reference\n\n### Core Methods\n\n```python\n# Client initialization\nclient = superu.SuperU(api_key)\n\n# Assistants\nclient.assistants.create_basic(**params)\nclient.assistants.create(**params)\n\n# Calls\nclient.calls.create(**params)\nclient.calls.create_twilio_call(**params)\nclient.calls.analysis(call_uuid)\nclient.calls.analysis_twilio_call(call_uuid)\n\n# Tools\nclient.tools.create(**params)\n```\n\n### Call Parameters\n\n| Parameter | Type | Required | Description |\n|-----------|------|----------|-------------|\n| `from_` | str | Yes | Caller ID (international format) |\n| `to_` | str | Yes | Recipient number (international format) |\n| `assistant_id` | str | Yes | Assistant ID to handle the call |\n| `max_duration_seconds` | int | No | Maximum call duration (default: 180) |\n| `first_message_url` | str | No | URL to initial audio message |\n\n## \ud83e\udd1d Support\n\n- **Documentation**: [dev.superu.ai](https://dev.superu.ai/)\n- **Issues**: Report bugs and feature requests on GitHub\n- **Email**: Contact support for enterprise solutions\n\n## \ud83d\udcc4 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## \ud83d\ude80 Getting Help\n\n```python\n# Example: Complete workflow\nimport superu\nimport time\n\n# Initialize\nclient = superu.SuperU('your_api_key')\n\n# Create assistant\nassistant = client.assistants.create_basic(\n    name=\"Demo Assistant\",\n    voice_id=\"90ipbRoKi4CpHXvKVtl0\",\n    first_message=\"Hello! This is a demo call.\",\n    system_prompt=\"You are a friendly demo assistant.\"\n)\n\n# Make call\ncall = client.calls.create(\n    from_='your_superu_number',\n    to_='+919876543210',\n    assistant_id=assistant['id']\n)\n\n# Wait for call completion\ntime.sleep(30)\n\n# Get analysis\nanalysis = client.calls.analysis(call['call_uuid'])\nprint(\"Call completed successfully!\")\n```\n\n---\n\n**Ready to build intelligent voice applications?** Get started with SuperU today!\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "SuperU SDK to make AI calls - Create intelligent voice assistants for automated phone calls",
    "version": "2025.7.9.2",
    "project_urls": {
        "Changelog": "https://github.com/superu/superu-python/releases",
        "Documentation": "https://dev.superu.ai",
        "Homepage": "https://dev.superu.ai",
        "Issues": "https://github.com/superu/superu-python/issues",
        "Repository": "https://github.com/superu/superu-python"
    },
    "split_keywords": [
        "ai",
        " voice",
        " assistant",
        " phone",
        " calls",
        " automation",
        " superu",
        " sdk"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "45ea8b56f767d7f34fda92d2d548ed198d6e5a25bb4b2e64b6a0fe12f8df2907",
                "md5": "af508e31bcbda82f057e811eef39428f",
                "sha256": "bedb4273b22153eaf938f5bad7889f0136ea9320e489a96a8bd283fa385c9108"
            },
            "downloads": -1,
            "filename": "superu-2025.7.9.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "af508e31bcbda82f057e811eef39428f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 14554,
            "upload_time": "2025-07-09T08:25:23",
            "upload_time_iso_8601": "2025-07-09T08:25:23.318231Z",
            "url": "https://files.pythonhosted.org/packages/45/ea/8b56f767d7f34fda92d2d548ed198d6e5a25bb4b2e64b6a0fe12f8df2907/superu-2025.7.9.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "799cd15f7d9c29f0954ddc937258e1fb679c79175fd65d970b71cd8c0fe32bb8",
                "md5": "b5493f6c303e62111e839a468e8b9cce",
                "sha256": "7b670a63b5ca032fb0c46d222f84543bd08489a44628169afc42b3f0c7cf4d46"
            },
            "downloads": -1,
            "filename": "superu-2025.7.9.2.tar.gz",
            "has_sig": false,
            "md5_digest": "b5493f6c303e62111e839a468e8b9cce",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 13747,
            "upload_time": "2025-07-09T08:25:24",
            "upload_time_iso_8601": "2025-07-09T08:25:24.714472Z",
            "url": "https://files.pythonhosted.org/packages/79/9c/d15f7d9c29f0954ddc937258e1fb679c79175fd65d970b71cd8c0fe32bb8/superu-2025.7.9.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-09 08:25:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "superu",
    "github_project": "superu-python",
    "github_not_found": true,
    "lcname": "superu"
}
        
Elapsed time: 0.52767s