Aiola Voice Streaming WebSocket API 1.0.0

Real-time audio streaming and transcription.

Servers

  • wss://api.aiola.ai/wssproduction

    Real-time WebSocket connection for audio streaming and transcription

    object
    transport
    required
    string

    Transport method for communication

    Default value:"all"
      Allowed values:
    • "polling"
    • "websocket"
    • "all"
    execution_id
    required
    string

    Unique identifier for the session/context (4-24 characters, alphanumeric)

    Default value:"session123"
    flow_id
    required
    string

    Identifier for a specific flow

    Default value:"C5f2da54-6150-47f7-9f36-e7b5dc384859 //public general flow id"
    lang_code
    required
    string

    Language code for speech recognition

    Default value:"en_US"
      Allowed values:
    • "en_US"
    • "es_ES"
    • "fr_FR"
    • "de_DE"
    • "pt_PT"
    • "ja_JP"
    • "it_IT"
    • "zh_CN"
    time_zone
    required
    string

    IANA timezone identifier

    Default value:"UTC"
    vad_config
    required
    string

    Voice activity detection configuration (JSON string)

    Default value:"{"vad_threshold": 0.5, "min_silence_duration_ms": 250}"
    Security:
    • HTTP
      • Scheme: bearer
      • Bearer format: JWT

Operations

  • SEND /api/voice-streaming/socket.io

    Speech-to-Text Socket.io API channel for audio streaming and LLM events.
    To connect to the Socket.io backend correctly, ensure you use the /event namespace.

    Operation IDsendAudio

    Available only on servers:

    Accepts the following message:

    binaryData
    Message IDbinaryData
    Payload
    restricted any
    format: binary

    Raw PCM audio chunk.
    must be in 16KHz, 16-bit, mono format.

    Examples

  • SEND /api/voice-streaming/socket.io

    Speech-to-Text Socket.io API channel for audio streaming and LLM events.
    To connect to the Socket.io backend correctly, ensure you use the /event namespace.

    Operation IDsendKeywords

    Available only on servers:

    Accepts the following message:

    setKeywords
    Message IDsetKeywords
    object

    Examples

  • RECEIVE /api/voice-streaming/socket.io

    Speech-to-Text Socket.io API channel for audio streaming and LLM events.
    To connect to the Socket.io backend correctly, ensure you use the /event namespace.

    Operation IDreceiveTranscript

    Available only on servers:

    Accepts the following message:

    transcript
    Message IDtranscript
    object

    Examples

  • RECEIVE /api/voice-streaming/socket.io

    Speech-to-Text Socket.io API channel for audio streaming and LLM events.
    To connect to the Socket.io backend correctly, ensure you use the /event namespace.

    Operation IDreceiveError

    Available only on servers:

    Accepts the following message:

    error
    Message IDerror
    object

    Examples

  • RECEIVE /api/voice-streaming/socket.io

    Speech-to-Text Socket.io API channel for audio streaming and LLM events.
    To connect to the Socket.io backend correctly, ensure you use the /event namespace.

    Operation IDreceiveEvents

    Available only on servers:

    Accepts the following message:

    events
    Message IDevents
    object

    Examples

Schemas

  • binaryDataPayload
    restricted any
    format: binary

    Raw PCM audio chunk.
    must be in 16KHz, 16-bit, mono format.

  • object
  • object
  • object