This is the documentation for a previous version of our product. Click here to see the latest version.

Verify and Go (Batch)

This section explains how to verify the correct operation of the Batch Virtual Appliance using the REST Speech API.

Check that all the Speechmatics services within the appliance are up and running before passing the audio file. The Management REST API can be used for this.

  • Method: GET
  • URL:
    http://${APPLIANCE_HOST}:8080/v1/management/services

To run a simple transcription job to test that everything is working use the Batch Virtual Appliance Speech API (on port 8082)

  • Method: POST
  • URL:
    http://${APPLIANCE_HOST}:8082/v1/user/1/jobs

For example, you can use the following Speech API request using the curl command-line tool to transcribe an audio file 'sample.wav' and return the Job ID:

curl -s -L -X POST 'http://${APPLIANCE_HOST}:8082/v1/user/1/jobs/' \
   -H 'Accept: application/json' \
   -H 'Content-Type: multipart/form-data' \
   -F data_file=@sample.wav \
   -d 'config={ "type": "transcription",
         "transcription_config": { "language": "en" }
      }' \
   | jq '.id'

Where ${APPLIANCE_HOST} is the hostname or IP address of your virtual appliance. The above assumes that sample.wav contains English speech; modify the language identifier in the job config to match the language you want to transcribe.

You can use the Job ID to get the status of the job:

curl -s -L -X GET 'http://${APPLIANCE_HOST}:8082/v1/user/1/jobs/${JOB_ID}/' \
   -H 'Accept: application/json' \
   | jq

Where ${JOB_ID} is the Job ID (id field) that was returned when you submitted the job. Once the job is done, you use the Job ID to return the transcription:

curl -s -L -X GET 'http://${APPLIANCE_HOST}:8082/v1/user/1/jobs/${JOB_ID}/transcript?format=json-v2' \
   -H 'Accept: application/vnd.speechmatics.v2+json' \
   | jq

Under normal conditions, the job should take less than half the duration of the media file to process. So for example if you submit a MP3 file that is 60 minutes long, its transcription should be processed in less than 30 minutes. See the REST Speech API Guide for the list of language codes, how to use features of the API, the output formats that are supported, as well as more usage examples.

The Speechmatics Batch Virtual Appliance is now ready to use.