The ITSLanguage API 3.1.0

Websocket server providing various speech related services.

  • #ASR

Servers

  • api.itslanguage.nlwssITSLanguage API
  • staging.itslanguage.nlwssITSLanguage Staging API

Operations

  • PUB /recording

    Save a recording with no additional processing.

    Operation IDrecording

    Available only on servers:

    Accepts one of the following messages:

    • #0start_recording

      Start a recording.

      Message IDstart_recording

      Start a recording.

      object

      Examples

    • #1write_recording

      Write audio to a recording.

      Message IDwrite_recording

      Send WAV data to the recording.

      object

      16-bit signed integer PCM WAV data. Minimal sample rate 16khz higher frequencies are downsampled, higher frequencies are still preferred as the quality can be higher. Stereo will be downsampled to mono.

      Examples

    • #2end_recording

      End the recording

      Message IDend_recording

      End and save the recording.

      object

      Examples

  • PUB /prompt

    Get feedback on how well a given prompt was read.

    Operation IDprompt_recording

    Available only on servers:

    Accepts one of the following messages:

    • #0start_recording

      Start a recording.

      Message IDstart_recording

      Start a recording.

      object

      Examples

    • #1write_recording

      Write audio to a recording.

      Message IDwrite_recording

      Send WAV data to the recording.

      object

      16-bit signed integer PCM WAV data. Minimal sample rate 16khz higher frequencies are downsampled, higher frequencies are still preferred as the quality can be higher. Stereo will be downsampled to mono.

      Examples

    • #2end_recording

      End the recording

      Message IDend_recording

      End and save the recording.

      object

      Examples

  • SUB /prompt

    Realtime feedback from the prompt.

    Operation IDprompt_feedback

    Available only on servers:

    Accepts the following message:

    feedback

    Prompt feedback

    Message IDfeedback

    Feedback on how well the speaker matches the prompt this can include omission words and pronunciation changes.

    object

    Examples

  • PUB /asr

    Get a transcription of the audio.

    Operation IDasr_recording

    Available only on servers:

    Accepts one of the following messages:

    • #0start_recording

      Start a recording.

      Message IDstart_recording

      Start a recording.

      object

      Examples

    • #1start_diarization

      Start a diarization.

      Message IDstart_diarization

      Start a diarization.

      object

      Examples

    • #2write_recording

      Write audio to a recording.

      Message IDwrite_recording

      Send WAV data to the recording.

      object

      16-bit signed integer PCM WAV data. Minimal sample rate 16khz higher frequencies are downsampled, higher frequencies are still preferred as the quality can be higher. Stereo will be downsampled to mono.

      Examples

    • #3end_recording

      End the recording

      Message IDend_recording

      End and save the recording.

      object

      Examples

  • SUB /asr

    Realtime transcription of the recording.

    Operation IDasr

    Available only on servers:

    Accepts the following message:

    asr

    Transcription

    Message IDasr

    Transcription of a given recording.

    Examples

  • PUB /align

    Get an alignment of the audio on a given text

    Operation IDalign_recording

    Available only on servers:

    Accepts one of the following messages:

    • #0start_recording

      Start a recording.

      Message IDstart_recording

      Start a recording.

      object

      Examples

    • #1write_recording

      Write audio to a recording.

      Message IDwrite_recording

      Send WAV data to the recording.

      object

      16-bit signed integer PCM WAV data. Minimal sample rate 16khz higher frequencies are downsampled, higher frequencies are still preferred as the quality can be higher. Stereo will be downsampled to mono.

      Examples

    • #2end_recording

      End the recording

      Message IDend_recording

      End and save the recording.

      object

      Examples

  • SUB /align

    Non-realtime alignment to the given text.

    Operation IDalignment

    Available only on servers:

    Accepts the following message:

    alignment

    Alignment

    Message IDalignment

    Examples

Messages

  • #1start_recording

    Start a recording.

    Message IDstart_recording

    Start a recording.

    object
  • #2start_diarization

    Start a diarization.

    Message IDstart_diarization

    Start a diarization.

    object
  • #3write_recording

    Write audio to a recording.

    Message IDwrite_recording

    Send WAV data to the recording.

    object

    16-bit signed integer PCM WAV data. Minimal sample rate 16khz higher frequencies are downsampled, higher frequencies are still preferred as the quality can be higher. Stereo will be downsampled to mono.

  • #4end_recording

    End the recording

    Message IDend_recording

    End and save the recording.

    object
  • #5feedback

    Prompt feedback

    Message IDfeedback

    Feedback on how well the speaker matches the prompt this can include omission words and pronunciation changes.

    object
  • #6asr

    Transcription

    Message IDasr

    Transcription of a given recording.

  • #7alignment

    Alignment

    Message IDalignment

Schemas

  • object
  • object

    16-bit signed integer PCM WAV data. Minimal sample rate 16khz higher frequencies are downsampled, higher frequencies are still preferred as the quality can be higher. Stereo will be downsampled to mono.

  • object
  • object