V-Spark Online Help

Reference for the /transcribe API

The /transcribe API enables you to submit files for transcription.

Synopsis

Note

The /transcribe API can not be called as a single URL from the command line due to its combination of resource and query parameters. See Examples of calling the /transcribe API for examples of using the curl command to test this API from the command line by using special curl options to pass form and multi-part data.

Variables used in a call to the /transcribe API are the following:

SERVER

The name or IP address of the computer system on which V‑Spark is installed

ORG_SHORT

The short name of the organization that you are using. Finding that information is shown in /transcribe API Reference.

FOLDER

The name of the V‑Spark Folder to which you want to upload the zip file containing your audio file(s).

Description

The /transcribe method takes the following options to provide authentication information and to identify the zip file that you are attempting to upload:

token

The V‑Spark authorization token that you are using to establish permission to submit files. The token used to authorize transcription requests can either be the root token for your V‑Spark installation, or the company authorization token. Refer to V‑Spark API Permission Requirements for information about locating a company authorization token.

file

The name of the file or zip file containing the information that you want to be transcribed and/or analyzed

Upon success, the /transcribe method returns a Universally Unique ID (UUID) that identifies the transcription request. All transcripts produced as a result of the request will include a "requestid" field with its value set to this UUID.

Content Types

  • POST method expects to receive options with the "multipart/form-data" MIME type, and returns data with the "text/html" MIME type

  • Errors will be returned with the "text/html" MIME type