The Quicktate API allows you to seemlessly integrate our audio transcription backend into your applications. Now you can leverage our quick turnaround times and professional quality to provide audio transcription services to your customers.
To use Quicktate's API, you must sign up for a developer account. Visit our sign up page and check the "I'm a developer" box. You will be assigned an API Key which you will use to communicate with our transcription platform.
Using our API consists of two steps. The first step is to submit your audio file into our system, along with any metadata you would like to be returned along with the transcription. This will be referred to as "Job Submission". The second step, is our system submitting the results back to you. This will be referred to as the "Result Callback"
The overall process of successfully transcribing an audio file is as follows:
You can also reference the Job ID to check the status of a transcription at any time using our "job.status" command.
Our API is powered by the XML-RPC protocol. Examples on this page will be provided for PHP, but XML-PRC libraries are available for every mainstream programming language. A few example libraries are:
Quicktate's XML-RPC API is hosted at http://api.quicktate.com/api/xml-rpc on port 80.
Methods
job.submit
This command submits an audio file into our system for transcription, and returns a unique Job ID which you can use to check the status of the submitted job.
Returns:
PHP Example:
job.status
Checks the status of a submitted job, returning the partial transcription if the job is still being processed, and the full transcription if the job is complete.
Returns:
job.cancel
Cancels an unassigned transcription. Can only be executed when status = 0
Returns:
Sends POST data to the URL of your choice. Specify the URL you would like the data to be posted to in the 'callbackdest' field when submitting your job. The following variables will be posted:
We advise that you don't completely rely on callback URLs for receiving transcription results. In the event that your callback server has a connectivity issue, you will never receive the result. We recommend using both a callback URL, and also periodically polling the job.status command for incomplete jobs.
If you specify timestamp=1 when submitting an audio file, the result will be returned with timestamped words. This is very useful for closed captioning, call auditing, and generating podcast transcriptions.
The timestamped result will return in the standard "result" field of both our HTTP POST callback and the job.status command. Timestamps are provided in HH:MM:SS.m format.
Example:
If you have any questions regarding implementing our API in your application, feel free to contact our friendly support team at support@quicktate.com
We're always excited to see our customers' innovations - let us know what you're working on.