Speech-to-Text Streaming API 1.0.0

Speech-to-Text streaming WebSocket API documentation

Servers

  • ws://example.com/stt/streamwsstt_stream_server

    WebSocket server for Speech-to-Text streaming

Operations

  • PUB /stt/stream

    Sent user notification about API Key for authorization

    Operation IDpublish

    Available only on servers:

    object
    key
    required
    string

    API key for authorization

    lang
    required
    string

    Language selection for transcription

    Accepts the following message:

    key

    API key for authorization

    Message IDkey
    Payload
    string

    Examples

  • SUB /stt/stream

    Receive transcribed audio data updates

    Operation IDsubscribe

    Available only on servers:

    object
    key
    required
    string

    API key for authorization

    lang
    required
    string

    Language selection for transcription

    Accepts one of the following messages:

    • #0audioChunk

      Audio Data

      Message IDaudioChunk
      Payload
      string
      format: binary

      Examples

    • #1start

      Start recording process Event

      Message IDstart

      Examples

    • #2end

      End recording process Event

      Message IDend

      Examples

Messages

  • #1audioChunk

    Audio Data

    Message IDaudioChunk
    Payload
    string
    format: binary
  • #2start

    Start recording process Event

    Message IDstart
  • #3end

    End recording process Event

    Message IDend
  • #4disconnect

    Client disconnect

    Message IDdisconnect
  • #5key

    API key for authorization

    Message IDkey
    Payload
    string