> ## Documentation Index
> Fetch the complete documentation index at: https://daily-docs-pr-4892.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Simplismart

> Streaming text-to-speech service implementation using the Simplismart API

export const CommunityMaintained = ({maintainer, maintainerUrl, repo}) => <Note>
    <strong>Community-maintained integration.</strong> This service is built and
    maintained by{" "}
    <a href={maintainerUrl} target="_blank" rel="noreferrer">
      {maintainer}
    </a>
    . Pipecat does not test or officially support it. Please report issues and
    request changes on the{" "}
    <a href={repo} target="_blank" rel="noreferrer">
      source repository
    </a>
    . Learn more about{" "}
    <a href="/api-reference/server/services/community-integrations">
      community integrations
    </a>
    .
  </Note>;

<CommunityMaintained maintainer="simpli-smart" maintainerUrl="https://github.com/simpli-smart" repo="https://github.com/simpli-smart/pipecat-simplismart" />

## Overview

`SimplismartHttpTTSService` generates speech from text using the
[Simplismart](https://simplismart.ai) streaming `/tts` API. Audio is returned as
raw PCM (s16le, mono) at 24 kHz, suitable for real-time voice pipelines.

<CardGroup cols={2}>
  <Card title="Source Repository" icon="github" href="https://github.com/simpli-smart/pipecat-simplismart">
    Source code, examples, and issues for the Simplismart integration
  </Card>

  <Card title="Simplismart" icon="book" href="https://simplismart.ai">
    Learn more about Simplismart and its AI services
  </Card>
</CardGroup>

## Installation

This is a community-maintained package distributed separately from `pipecat-ai`.
It is not published to PyPI, so install it from source:

```bash theme={null}
uv pip install git+https://github.com/simpli-smart/pipecat-simplismart.git
```

## Prerequisites

### Simplismart Account Setup

Before using the Simplismart text-to-speech service, you need a Simplismart
account and API key. See [Simplismart](https://simplismart.ai) to get started.

### Required Environment Variables

* `SIMPLISMART_API_KEY`: Bearer token used to authenticate TTS requests. Can be
  passed directly via the `api_key` constructor argument instead.
* `SIMPLISMART_TTS_URL`: TTS endpoint URL. Defaults to
  `https://api.simplismart.live/tts` if not set.

## Configuration

<ParamField path="api_key" type="str" default="None">
  Simplismart bearer token. Falls back to the `SIMPLISMART_API_KEY` environment
  variable if not provided.
</ParamField>

<ParamField path="base_url" type="str" default="None">
  TTS endpoint URL (e.g. `https://api.simplismart.live/tts`). Falls back to the
  `SIMPLISMART_TTS_URL` environment variable, then to
  `https://api.simplismart.live/tts`.
</ParamField>

<ParamField path="aiohttp_session" type="aiohttp.ClientSession" default="None">
  Optional shared HTTP client session. If not provided, the service creates and
  manages its own session.
</ParamField>

<ParamField path="sample_rate" type="int" default="None">
  Output sample rate. Should match `SimplismartHttpTTSService.SAMPLE_RATE`
  (24000) for correct playback.
</ParamField>

<ParamField path="settings" type="SimplismartHttpTTSService.Settings" default="None">
  Voice, model, and generation settings. See [Settings](#settings) below.
</ParamField>

### Settings

Runtime-configurable settings passed via the `settings` constructor argument
using `SimplismartHttpTTSService.Settings(...)`.

| Parameter            | Type    | Default                          | Description                                 |
| -------------------- | ------- | -------------------------------- | ------------------------------------------- |
| `model`              | `str`   | `"canopylabs/orpheus-3b-0.1-ft"` | Simplismart TTS model identifier.           |
| `voice`              | `str`   | `"tara"`                         | Voice used for speech generation.           |
| `temperature`        | `float` | `0.7`                            | Sampling temperature for speech generation. |
| `top_p`              | `float` | `0.9`                            | Top-p nucleus sampling.                     |
| `repetition_penalty` | `float` | `1.5`                            | Repetition penalty.                         |
| `max_tokens`         | `int`   | `1000`                           | Max new tokens for the TTS model.           |

<Note>
  Available parameters and defaults are defined by the integration. See the
  [source repository](https://github.com/simpli-smart/pipecat-simplismart) for
  the authoritative, up-to-date list.
</Note>

## Usage

```python theme={null}
from pipecat_simplismart import SimplismartHttpTTSService

tts = SimplismartHttpTTSService(
    api_key="YOUR_KEY",
    base_url="https://api.simplismart.live/tts",
    sample_rate=SimplismartHttpTTSService.SAMPLE_RATE,
    settings=SimplismartHttpTTSService.Settings(
        model="canopylabs/orpheus-3b-0.1-ft",
        voice="tara",
    ),
)

# ... add tts to your pipeline.
```

## Compatibility

Tested with Pipecat v1.1.0 (`pipecat-ai>=0.0.86`). Check the [source
repository](https://github.com/simpli-smart/pipecat-simplismart) for the latest
tested version and changelog.