V-Blaze and V-Cloud Online Help

Common Tags

Table 1. Common /transcribe API Parameters for V‑Blaze




callback (optional)

URL: HTTP or HTTPS are supported

The URL to which V-Blaze will POST transcripts. A callback is the address and (optionally) method name and parameters of a web application that can receive data via HTTP or HTTPS. Callbacks are usually used to enable another application to receive and directly interact with the transcripts produced.

V‑Blaze transcripts are normally returned immediately and directly to the user or application that submitted the audio file for transcription. When a callback is specified, the resultant transcript is POSTed to the specified callback address and not returned in the response. V‑Blaze does not retry failed callbacks.

file (required)

PCM audio data in WAVE or RAW format

A single audio file to process.

model (optional) –

see language models

Indicates which language model(s) should be used to transcribe the audio. This parameter can be set to a single language model or a list of language models. If not specified, the default model will be used. Refer to model for more information on this parameter.

output (optional)

Values: json (default), jsontop, text

Indicates the desired output format. Refer to output for more information on this parameter.


false (default), true

Controls whether or not the ASR engine is processing incoming audio in real-time mode or not. Real-time mode is enabled based on a license setting and cannot be enabled using this setting if it is not enabled in the license. This tag is only useful to specify that the ASR engine not process incoming audio in real-time even though real-time is enabled in the license.


The unique identifier for the request for tracing purposes. This can be specified as a parameter or in the X-Request-Id HTTP header. If a requestid is provided in one of these ways, the specified requestid is included in JSON output and in the WebAPI access log.

Refer to requestid for WebAPI for more information on how to use requestid.