+1 866 941 4131 (/contact-us#phone) Login (/account/login) Sign Up (/account/sign-up) UPLOAD (/FILES/UPLOAD)
Audio Transcription, Perfected
HOME (/)
PRICING (/TRANSCRIPTION/PRICING)
CALLS (/CONFERENCE/RECORDING)
CONTACT (/CONTACT-US)
Audio/Video Transcription API
Errors
Introduction
Files Resource
The Scribie.com HTTP 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 Strict-Transport-Security: max-age=63072000
GET requests to this resource returns the transcript. We provide transcripts in .doc, .pdf, .odt and .txt formats, and .sbv and .srt formats if the subtitle_file option is enabled. 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 curl -X GET --user 764118cada1d4d7c899999434c00e761ac24b5c3: \ https://api.scribie.com/v1/file/5a5290c74787b392e31bfc81124ec11c9abf622c.txt
Example Response NOTICE Work-In-Progress Transcript This transcript is not yet complete. It may have missing sections, higher number of mistakes, blanks and speaker track ing inconsistencies. ---00:01 Austin Tuan: Hello. 00:05 Rajiv Poddar: Hello. 00:07 AT: Yes. Rajiv can you hear me. 00:10 RP: Yeah, I can hear you. 00:11 AT: Hi. This is Austin Taun from Taipei, Taiwan. 00:17 RP: Hi Austin. How are you. 00:19 AT: I'm fine. Okay, so today, Rajiv could you first introduce yourself a little bit. ...
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 curl -X DELETE --user 764118cada1d4d7c899999434c00e761ac24b5c3: \ https://api.scribie.com/v1/file/5a5290c74787b392e31bfc81124ec11c9abf622c
A subsequent GET will return a 404 not found error.
Webhook A webhook URL can be configured from the settings (/settings#api-key) 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 { "id":"5a5290c74787b392e31bfc81124ec11c9abf622c" }
Usage Example Assuming that your Scribie.com 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. curl -X POST --user 764118cada1d4d7c899999434c00e761ac24b5c3: -F
[email protected] \ https://api.scribie.com/v1/files
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. curl -I -X GET --user 764118cada1d4d7c899999434c00e761ac24b5c3: \ https://api.scribie.com/v1/file/
Step 3: When the progress_perecent is 100, you can send a GET request for the Word Document as well and save it somewhere. curl -X GET --user 764118cada1d4d7c899999434c00e761ac24b5c3: \ https://api.scribie.com/v1/file/.doc -o test.doc
That's it! These three requests are equivalent to uploading a file, ordering the transcript and then downloading the transcript through our web interface.
Support We provide only email support for the API. Please send an email to
[email protected] for any questions or assistance.
File Resource Webhook Usage Example Support
© Copyright 2008-2018 by CGBiz Corporation.
Blog (/blog/) | FAQ (/faq) | Free Transcript (/transcription/free) | Transcribers (/freelance-transcription#intro) | Affiliates (/affiliate) | API
All Rights Reserved.
(/docs/api) | Terms (/terms-of-service) | Privacy (/privacy-policy) | About (/about-us) | Contact (/contact-us?subject=General Enquiry) | Jobs (/jobs) | Live Chat