REST API Documentation

Use our services to create your own unique application!


The REST API provides a programmable interface to our transcription service. The core functionality provided by our web interface is made available through this API. An application can upload files to our servers, pay for transcription, check the transcript progress, fetch the transcripts and delete the files.

This document describes the resources and methods which are exposed by the API. The target audience for this document are server side application developers. The curl examples are used throughout this document to illustrate the usage of the API.

This API exposes two resources: files and file. The file resource refers to an individual file whereas the files resource is a collection of file's. The GET requests can be used to retrieve the resource and any meta data associated with it. The POST request modifies the state of the resource.

The endpoint URL for the API is Only HTTPS is supported. HTTP requests will be redirected to HTTPS. The API is currently in version 1. The encoding used is application/json; charset=utf-8, except for the filesPOST request which is multipart/form-data.

A sandbox environment is available for testing at the endpoint URL The data is retained for 24 hours only.

An account on with a saved payment method is required in order to use this API. Please sign-up if you do not have an account yet.

Only email support is available for the API. Please send your questions to


This API uses HTTP Basic authentication with the API key as the user. The API key can be generated from the account settings page. All requestsmust be authenticated.

Example Request

The API key should be kept secret in order to prevent misuse of the account.


This API returns errors via HTTP response codes. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing, or file type is unsupported, etc.). The 500 error code is returned if an unexpected application error occurs during processing. Additionally a error string is provided as a hint in the response body.

Example Response

Error Reference

400Bad requestfiles POSTThe file parameter is missing
Options parameter is incorrectly formatted
401UnauthorizedAllThe API Key is missing or was not found
404Not foundfile GET
Incorrect file id
File was deleted
405Method not allowedAllThe error message has a list of allowed methods
409Conflictfile DELETEThe transcript progress is >= 60% and file cannot be deleted at this stage, try again after 100%
413Request entity too largefiles POSTFile size is > 10 GB
415Unsupported file typefiles POST
file GET
The error message has a list of supported file types
500Internal server errorAllContact support with the error message

Files Resource

Methods allowed: GET, POST

This resource represents a collection of the file resource. The GET method returns a list of file identifiers. The identifier can be used to send requests to the individual file resource.

Example Request

Example Response

This POST request is used to create a new file. The following pre-conditions should be met for this request to be processed.

  • The request must contain a file or link parameter in the body.
  • The content type must be multipart/form-data.
  • If the paramter in the body is link then it should be publicly downloadable link.
  • The file size must be less than 10 GB.
  • The file format must be one of the following: mp3, wav, wma, wmv, avi, flv, mpg, mpeg, mp4, m4a, m4v, mov, ogg, webm, aif, aiff, amr, 3gp, 3ga, mts, ogv, aac, mkv, mxf, opus, flac. The format is determined from the MIME type of the file.

The response code is 201 if the file creation was successful. The credit card is charged towards the transcription cost on successful creation.

Example Request

Example Response


The following options can be specified in the query parameters. The default transcript order options is applied if an option is not found. Please note that spaces in the values have to be escaped.

Example Request

full names
transcript_templatescribie single line spaced
scribie double line spaced
blank single line spaced
blank double line spaced
scribie single line spaced
speaker_namesComma separated list. Eg. John Doe, Jane DoeNone
instructionsAny special instructions for transactions. Eg. Hello this is a test instructions.None
custom_formatting_detailsCustom Formatting Details. Eg. {data: 'cddc'}None

The options are case insensitive. The default options can be overridden from the settings page. Some of these options are charged. Please check the Pricing and the service details page for more information. For the automated transcript type, all options are ignored. For using custom formatting, you have to enabled it first and contact support to use this option.

File Resource

Methods allowed: GET, POST, DELETE

This resource represents an individual file. The HEAD method returns meta data in the X-Scribie-Metadata header as a JSON string. All dates in the meta data are in the ISO 8601 format. It also contains the options which were applied. The scheduled delivery date is returned in the delivery parameter. The progress_percent parameter is a measure of the completeness of the transcript.

Example Request

Example Response

GET requests to this resource returns the transcript. We provide transcripts in .doc, .pdf, .odt, .txt, .sbv, .srt and .json formats. The extension can be appended to the file identifier to retrieve the desired format. The default format is .txt. If the progress is less than 100% then the Work-In-Progress transcript is returned in .txt format.

Example Request

Example Response

The JSON format is an array of objects. The description of each key in the object is provided below:

wordThe predicted word. This may or may not contain punctuation marks.
startThe second in the audio file where the utterance of this word starts.
endThe second in the audio file where the utterance of this word ends.
durationThe length if the word in seconds.
confThe confidence value of the acoustic model. This is a float value between 0 to 1, where 1 is the highest confidence.
turnThe presence of this indicates that there is a speaker turn after this word. This may or may not be present for all objects.
turn_confThe confidence level of the acoustic model associated with the turn. This is a float value between 0 to 1, where 1 is the highest confidence.

The following code snippet illustrates how to get the transcript from JSON file in Python

Example Request

The DELETE request removes the file from our server and all the meta data associated with it. The file can be deleted only if the progress is below 60%, or when the transcript is complete, i.e., 100%. In the former case, a refund is also issued. The refund amount proportional to the progress and is issued after 1 business day. The response body is empty if the operation is successful.

Example Request

A subsequent GET will return a 404 not found error.


A webhook URL can be configured from the settings page. On any progress update, the file id is POST'ed to the URL. The request is JSON encoded. A subequent HEAD on the id returns the updated progress value in the X-Scribie-Metadata header.

Sample POST Body

Usage Example

Assuming that your account is set up (signed up, saved a credit card and generated an API key), the following steps have to be performed in order get the transcript of test.wav file.

Step 1: POST the file to the files resource. This returns the id of the file which should be saved.

Step 2: Send a GET request to the file with the id, parse the X-Scribie-Metadata header in the response and check the progress_percent field. If progress is less than 100 then the Work-In-Progress transcript will be returned, otherwise the final transcript in text format will be returned. If the Webhook is configured, this request should be sent immediately after receiving the Webhook POST.

Step 3: When the progress_perecent is 100, you can send a GETrequest for the Word Document as well and save it somewhere.

That's it! These three requests are equivalent to uploading a file, ordering the transcript and then downloading the transcript through our web interface.


We provide only email support for the API. Please send an email to for any questions or assistance.