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

    Accepts one of the following messages:

    • #0start_recording

      Start a recording.

      Start a recording.

      object
      uid: start_recording

      Examples

    • #1write_recording

      Write audio to a recording.

      Send WAV data to the recording.

      object
      uid: write_recording

      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

      End and save the recording.

      Examples

  • PUB /prompt

    Get feedback on how well a given prompt was read.

    Operation IDprompt_recording

    Accepts one of the following messages:

    • #0start_recording

      Start a recording.

      Start a recording.

      object
      uid: start_recording

      Examples

    • #1write_recording

      Write audio to a recording.

      Send WAV data to the recording.

      object
      uid: write_recording

      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

      End and save the recording.

      Examples

  • SUB /prompt

    Realtime feedback from the prompt.

    Operation IDprompt_feedback

    Accepts the following message:

    feedback

    Prompt feedback

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

    object
    uid: feedback

    Examples

  • PUB /asr

    Get a transcription of the audio.

    Operation IDasr_recording

    Accepts one of the following messages:

    • #0start_recording

      Start a recording.

      Start a recording.

      object
      uid: start_recording

      Examples

    • #1start_diarization

      Start a diarization.

      Start a diarization.

      object
      uid: start_recording

      Examples

    • #2write_recording

      Write audio to a recording.

      Send WAV data to the recording.

      object
      uid: write_recording

      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

      End and save the recording.

      Examples

  • SUB /asr

    Realtime transcription of the recording.

    Operation IDasr

    Accepts the following message:

    asr

    Transcription

    Transcription of a given recording.

    Examples

Messages

  • #1start_recording

    Start a recording.

    Start a recording.

    object
    uid: start_recording
  • #2start_diarization

    Start a diarization.

    Start a diarization.

    object
    uid: start_recording
  • #3write_recording

    Write audio to a recording.

    Send WAV data to the recording.

    object
    uid: write_recording

    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

    End and save the recording.

  • #5feedback

    Prompt feedback

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

    object
    uid: feedback
  • #6asr

    Transcription

    Transcription of a given recording.

Schemas

  • object
    uid: start_recording
  • object
    uid: write_recording

    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
    uid: end_recording
  • object
    uid: feedback