Obtaining transcription results

Using a callback to automatically return results from V‑Cloud is the recommended way of using V‑Cloud, since it provides the shortest turnaround time between issuing a /transcribe request and receiving the results. Results return as soon as transcription completes and no subsequent request is required to retrieve the results. The callback mechanism is the most efficient way to use V‑Cloud.

By default, the results produced by V‑Cloud differ based on whether you submitted a single audio file or a zip file containing one or more audio files.

If you submit a non-zipped audio file, the result is a JSON transcript of that audio file (unless you specified other options).
If you submit one or more audio files contained in a zip file, the result is a zip file that contains the transcript(s) of the audio files in the zip archive (unless you specified other options).

Tip: Uploading and downloading zip files is recommended to minimize network bandwidth consumption.

A requestid is returned in response to any transcription request for tracking or retrieval (if no callback is specified or the callback fails).

Using the recommended callback flow

If you specify a callback, results are sent to the specified endpoint as soon as transcription completes. The callback server must be able to receive multipart requests containing the results and the associated requestid. For example, the following request simulates the data that would be sent from V‑Cloud to your callback server.

curl -F "file=@samples.zip;type=application/zip" \
     -F requestid=700e7496-4fce-4963-aa7b-b3b26600f813 \
      https://hostname:port/endpoint

The example above demonstrates the two required form-data fields of the multipart request that the callback server needs to handle. Make sure that your callback server correctly returns success (HTTP code 200) when these two fields are received. Results are automatically deleted from V‑Cloud once the callback succeeds. Refer to Receiving transcription results for more information on the data that V‑Cloud sends to a callback server.

Note: Using the


/transcribe/result

method in conjunction with a callback is not recommended because you will only be able to retrieve results if the callback has failed.

The following request instructs V‑Cloud to transcribe sample7.wav and send the results to the specified callback address:

curl -F callback=https://hostname:port/endpoint \
     -F "file=@sample7.wav;type=audio/x-wav" \
     -F token=your-token-here \
      https://vcloud.vocitec.com/transcribe