> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rumik.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# overview

> the rumik silk text-to-speech API.

silk is rumik AI's text-to-speech API. it turns text into natural, expressive
speech over a simple HTTP call or a real-time WebSocket stream. audio comes back
as 24 kHz mono PCM.

pick the model that fits your use case:

<CardGroup cols={2}>
  <Card title="silk muga 1" icon="masks-theater" href="/muga">
    our more expressive model. steer delivery with a tone tag like `[happy]` and
    inline events like `<laugh>`.
  </Card>

  <Card title="silk mulberry 1.5" icon="bolt" href="/mulberry">
    our faster model. steer with a natural-language `description`, or pick a
    preset studio voice.
  </Card>
</CardGroup>

## start here

<CardGroup cols={2}>
  <Card title="quickstart" icon="rocket" href="/quickstart">
    get a key and synthesize your first clip in three steps.
  </Card>

  <Card title="prompting guide" icon="pen-nib" href="/prompting-muga">
    steer muga and mulberry with tones, tags, and descriptions.
  </Card>

  <Card title="stream in real time" icon="waveform-lines" href="/streaming">
    low-latency playback over WebSocket.
  </Card>

  <Card title="build a voice agent" icon="microphone" href="/pipecat">
    drop rumik into a pipecat pipeline with `pipecat-rumik`.
  </Card>

  <Card title="API reference" icon="code" href="/api-reference">
    endpoints, request fields, and a live playground.
  </Card>
</CardGroup>

## your account

<CardGroup cols={2}>
  <Card title="get an API key" icon="key" href="https://playground.rumik.ai/api-keys">
    create and manage keys in your dashboard.
  </Card>

  <Card title="open dashboard" icon="gauge" href="https://playground.rumik.ai">
    track usage, credits, and billing.
  </Card>
</CardGroup>

## audio format

every response is **24 kHz, mono, signed 16-bit PCM**. the HTTP endpoint wraps it
in a WAV container (`audio/wav`); the WebSocket stream sends raw PCM chunks.

## status

live API uptime and incident history are at
[silk-api.statuspage.io](https://silk-api.statuspage.io).
