The V‑Cloud API is a collection of REST web services that can be accessed by any programming language capable of performing HTTP
GET calls. The following sections detail some essential concepts to get started with V‑Cloud.
Querying V‑Cloud status
The V‑Cloud API is primarily used to submit audio files for transcription and to get results, but can also be used to determine if V‑Cloud is available by querying the
A successful response returns HTTP code
and the text string
if the V‑Cloud server is available. You do not need to pass a token to the service in order to make this call.
Tokens are used to authorize and authenticate requests made to the V‑Cloud API. Please protect your token as you would any other shared secret. Use of the token enables direct billing of transcription hours to your account.
Endpoints and methods
The V‑Cloud API is comprised of two core methods:
POSTrequests containing an audio file or a zip file less than 250MiB containing one or more audio files to transcribe. Successful
/transcriberequests return a
requestidto identify results for retrieval and tracking.
GETrequests containing a valid
/transcribe/resultrequests return a URL with the results as a zip or JSON file. The format of your results depends on the options specified in the initial
V-Cloud limits the
/transcribe endpoint to 128 concurrent connections per IP address and the
/transcribe/result endpoint to 32 concurrent connections per IP address.