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

# Streaming Speech-to-Text

<ParamField header="Authentication" type="string" optional>
  Authentication string for the request.
</ParamField>

<ParamField query="sample_rate" type="integer" required>
  The sample rate of the streamed audio.
</ParamField>

<ParamField query="word_boost" type="string" optional>
  Add up to 2500 characters of custom vocabulary. The parameter value must be a JSON encoded array of strings. The JSON must be URL encoded like other query string parameters.
</ParamField>

<ParamField query="encoding" type="enum" optional default="pcm_s16le">
  The encoding of the audio data.
  Allowed values:

  pcm\_s16le
  pcm\_mulaw
</ParamField>

<ParamField query="token" type="string" optional>
  Authenticate using a generated temporary token.
</ParamField>

<ParamField query="disable_partial_transcripts" type="boolean" optional default="false">
  Set to true to not receive partial transcripts.
</ParamField>

<ParamField query="enable_extra_session_information" type="boolean" optional default="false">
  Set to true to receive the SessionInformation message before the session ends.
</ParamField>

<ResponseExample>
  ```text Messages theme={"system"}
  UklGRtjIAABXQVZFZ
  ```

  ```Json Messages theme={"system"}
  {
    "audio_start": 0,
    "audio_end": 1500,
    "confidence": 0.987190506414702,
    "text": "there is a house in new orleans",
    "words": [
      {
        "start": 0,
        "end": 300,
        "confidence": 1,
        "text": "there"
      }
    ],
    "created": "2023-05-24T08:09:10Z",
    "message_type": "PartialTranscript"
  }
  ```

  ```json Messages theme={"system"}
  {
    "audio_start": 0,
    "audio_end": 1500,
    "confidence": 0.987190506414702,
    "text": "there is a house in new orleans",
    "words": [
      {
        "start": 0,
        "end": 300,
        "confidence": 1,
        "text": "there"
      }
    ],
    "created": "2023-05-24T08:09:10Z",
    "message_type": "FinalTranscript",
    "punctuated": true,
    "text_formatted": true
  }
  ```

  ```json Messages theme={"system"}
  {
    "terminate_session": true
  }
  ```
</ResponseExample>