Getting started
The V‑Cloud API is a collection of REST web services that can be accessed by any programming language capable of performing HTTP POST
and 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
/status
endpoint.
URL:
https://vcloud.vocitec.com/status
Response:
OK
Explanation:
A successful response returns HTTP code
200
and the text string
OK
if the V‑Cloud server is available. You do not need to pass a token to the service in order to make this call.
Authorization token
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:
-
/transcribe
-
The
/transcribe
endpoint acceptsPOST
requests containing an audio file or a zip file containing one or more audio files to transcribe. Successful/transcribe
requests return arequestid
to identify results for retrieval and tracking. -
/transcribe/result
-
The
/transcribe/result
endpoint acceptsGET
requests containing a validrequestid
. Successful/transcribe/result
requests 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/transcribe
request.
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.