Submitting Transcription Requests
A transcription session is initiated by issuing an HTTP POST to the appropriate URL. The following is an example of an appropriate URL:
http://vblaze_name:17171/transcribe
Where vblaze_name is the name of your V‑Blaze server.
Note
The V‑Blaze REST API service monitors port 17171 by default, but this can be changed if necessary. If transmission encryption is required you can use HTTPS rather than HTTP.
Single Part POST
Important
This method requires V‑Blaze version 7.2 or greater.
Query the V-Blaze API using a simple, single-part post:
curl -s -X POST \ -T 'sample1.wav' \ 'vblaze_name:17171/transcribe'
Parameters may be included in the query string or as headers. For the sake of simplicity, parameters should always be placed in the query string. Headers should be reserved for heavy parameters, such as JSON-encoded data, or parameters that are inconvenient to place in the query string.
curl -s -X POST \ -T 'sample1.wav' \ 'vblaze_name:17171/transcribe?model=eng1:callcenter&output=text'
curl -s -X POST \ -T 'sample1.wav' \ -H 'X-Voci-Model: eng1:callcenter' \ -H 'X-Voci-Output: text' \ 'vblaze_name:17171/transcribe'
These examples transcribe a file named sample1.wav using a V‑Blaze REST API instance running on a server named vblaze_name; both parameters can be changed without altering the function of any commands.
Tip
This method is recommended for best performance.
Single Part PUT
Important
This method requires V‑Blaze version 7.3 or greater.
Query the V-Blaze API using a simple, single-part put:
curl -s -X PUT \ -T 'sample1.wav' \ 'vblaze_name:17171/transcribe'
Parameters may be included in the query string or as headers. For the sake of simplicity, parameters should always be placed in the query string. Headers should be reserved for heavy parameters, such as JSON-encoded data, or parameters that are inconvenient to place in the query string.
curl -s -X PUT \ -T 'sample1.wav' \ 'vblaze_name:17171/transcribe?model=eng1:callcenter&output=text'
curl -s -X PUT \ -T 'sample1.wav' \ -H 'X-Voci-Model: eng1:callcenter' \ -H 'X-Voci-Output: text' \ 'vblaze_name:17171/transcribe'
These examples transcribe a file named sample1.wav using a V‑Blaze REST API instance running on a server named vblaze_name; both parameters can be changed without altering the function of any commands.
Tip
This method is recommended for best performance.