Take Note Transcription API Documentation (Canonical)
Take Note Transcription API Documentation
The Take Note REST APIs are supported in two environments. Use the dev environment for testing purposes, then move to the live environment for production processing. When testing, generate an access token with your test credentials to make calls to the dev URIs. When you’re set to go live, use the live credentials assigned to your app to generate a new access token to be used with the live URIs. The following endpoints address our two environments:
API Login With Getting The Authorisation Token
Authorization(in the header)
username
password
grant_type
Basic dGVzdGNsaWVudDp0ZXN0cGFzcw
{your_username}
{your_password}
password
curl -X POST –header ‘Content-Type: application/x-www-form-urlencoded’ –header ‘Accept: application/json’ –header ‘Authorization: Basic dGVzdGNsaWVudDp0ZXN0cGFzcw’ -d ‘username={your_username}&password={your_password}&grant_type=password’ ‘https://api.takenotetyping.com/v1/oauth2/token’
Sample response:
{ "access_token": "{your_token}", "expires_in": 1209600, "token_type": "Bearer", "scope": null, "refresh_token": "{refresh_token}" }
Create a New Project
Authorization(in the header)
title
is_favorite (optional)
default (optional)
Bearer {your_token}
{project_title}
0 (false) or 1 (true)
0 (false) or 1 (true)
curl -X POST –header ‘Content-Type: application/x-www-form-urlencoded’ –header ‘Accept: application/json’ –header ‘Authorization: Bearer {your_token}‘ -d ‘title={project_title}&is_favorite=1′ ‘https://api.takenotetyping.com/v1/project’
Sample response:
{ "title": "{project_title}", "owner_id": "562f692a05dfe9560fb6e428", "is_favorite": false, "deadline": 1495897153, "status": "active", "default": false, "email_each_transcript_on_complete": 0, "priority": "normal", "created_at": 1488211153, "updated_at": 1488211153, "_id": "58b44cd16a63d3125bb2a62e", "owner_name": "", "members": [] }
Create a New Media File
Authorization(in the header)
title
extension
project ID
service_options[speakers]
service_options[turnaround]
service_options[id]
service_options[document] (optional)
service_options[timestamps] (optional)
Bearer {your_token}
{media_title}
{extension_of_media}
{project_id}
{number_of_speakers}
{required_turnaround_time}
{_id}
{document_type}
{timestamp_options}
Options:
project_id
extension
service_options[speakers]
service_options[turnaround]
service_options[id]
service_options[document] (optional)
service_options[timestamp] (optional)
curl -X POST \ https://api.takenotetyping.com/v1/media/create \ -H ‘authorization: {your_token}‘ \ -H ‘cache-control: no-cache’ \ -H ‘content-type: application/x-www-form-urlencoded’ \ -d ‘title={media_title}&extension={extension_of_media}&service_options%5Bid%5D={_id}&service_options%5Bturnaround%5D={required_turnaround_time}&service_options%5Bdocument%5D={document_type}&service_options%5Bspeakers%5D={number_of_speakers}&service_options%5Btimestamps%5D={timestamp_options}‘
Sample response:
{ "assign_notified": false, "title": "test media", "extension": "mp3", "service_options": { "id": "591abd079213ce19643e9b57", "turnaround": "48 hour", "document": "XML", "speakers": "2-3 Speakers", "timestamps": "Not Required", "name": "Summary" }, "project_id": "58fff3519213ce55a678ef97", "user_id": "562f692a05dfe9560fb6e428", "status": "pending", "quality": "normal", "short_id": 2, "created_at": 1494930888, "updated_at": 1494930888, "client_username": "clientuser", "client_email": "clientuser@gmail.com", "_id": "591ad5c89213ce3775150132", "file_id": "591ad5c89213ce3775150144", "order_id": "", "transcoding_status": "none", "price": null, "in_sfb_pool": false, "finished_transcript": "", "client_comments": "", "proofreader_username": "" }
User Profile Details
Authorization(in the header)
Bearer {your_token}
curl -X GET –header ‘Accept: application/json’ –header ‘Authorization: Bearer {your_token}‘ ‘https://api.takenotetyping.com/v1/user/profile’
Sample response:
{ "is_business_account": true, "_id": "562f692a05dfe9560fb6e428", "username": "clientuser", "email": "clientuser@gmail.com", "status": 2, "role": 4, "discount": 0, "credit": 0, "updated_at": 1488972283, "firstname": "", "lastname": "", "business_information": { "company_name": null, "company_number": null, "vat_number": null, "address": null, "directors": null, "contact_name": null, "contact_email": null, "contact_phone": null, "agreement": null }, "bank_information": { "account_name": "", "method_of_payment": "", "short_code": "", "account_number": "", "utrn_number": "", "registered_address": "" }, "statistics": { "nr_of_files": 3, "nr_of_projects": 4, "nr_of_pending_files": 2, "nr_of_completed_files": 0 }, "quickbooks_id": null, "infusionsoft_id": null, "profile": { "nick_name": "", "alternative_email": "", "security_email": "", "security_question": "", "security_answer": "", "mobile": "", "landline": "", "street": "", "post_code": "", "city": "", "country": "", "company": "", "general_comments": "", "custom_fields": "", "image_id": null, "bio": "", "date_of_birth": "", "utr": "", "contact_email": "", "contact_phone1": "", "contact_phone2": "", "contact_address": "", "image_url": null } }
List of Your Projects
Authorization(in the header)
Bearer {your_token}
curl -X GET –header ‘Accept: application/json’ –header ‘Authorization: Bearer {your_token}‘ ‘https://api.takenotetyping.com/v1/project’
Sample response:
{ [ { "_id": "5919912d7524c2671515f762", "title": "Test Project", "owner_id": "562f692a05dfe9560fb6e428", "is_favorite": false, "deadline": 1502796589, "status": "active", "default": false, "email_each_transcript_on_complete": 0, "priority": "normal", "created_at": 1494847789, "updated_at": 1494847789, "owner_name": "", "members": [] } ]}
List of Your Media Files
Authorization(in the header)
Bearer {your_token}
curl -X GET –header ‘Accept: application/json’ –header ‘Authorization: Bearer {your_token}‘ ‘https://api.takenotetyping.com/v1/media/list-my-media’
Sample response:
{ [ { "assign_notified": false, "_id": "591ad5c89213ce3775150132", "title": "test media", "extension": "mp3", "service_options": { "id": "591abd079213ce19643e9b57", "turnaround": "48 hour", "document": "XML", "speakers": "2-3 Speakers", "timestamps": "Not Required", "name": "Summary" }, "project_id": "58fff3519213ce55a678ef97", "user_id": "562f692a05dfe9560fb6e428", "status": "pending", "quality": "normal", "short_id": 2, "created_at": 1494930888, "updated_at": 1494930888, "client_username": "clientuser", "client_email": "clientuser@gmail.com", "file_id": "591ad5c89213ce3775150144", "order_id": "", "transcoding_status": "none", "price": null, "in_sfb_pool": false, "finished_transcript": "", "client_comments": "", "proofreader_username": "" } ]}
List the Available Services
Authorization(in the header)
Bearer {your_token}
curl -X GET \ https://api.takenotetyping.com/v1/new-service \ -H ‘authorization: Bearer 5d882bdb171e05d5f3c9d0517a54237ec34c5eab’ \ -H ‘cache-control: no-cache’
Sample response:
{ [ { "_id": "5919de689213ce026f3ae250", "name": "Summary", "short_name": "SUM", "type": "Legal", "turnaround": [ "48 hour", "24 hour", "12 hour" ], "timestamps": [ "Not Required", "Every Speaker" ], "document": [ "Plain text", "Word", "XML" ], "speakers": [ "1 (Dictation)", "2-3 Speakers", "4+ Speakers" ], "status": "active", "price_calculation_elements": [], "api": true, "mobile": true, "created_at": 1494867560, "updated_at": 1494867560 } ]}
Get Details From a Media File
Authorization(in the header)
media_id(in the path)
Bearer {your_token}
{media_ID}
curl -X GET –header ‘Accept: application/json’ –header ‘Authorization: Bearer {your_token}‘ ‘https://api.takenotetyping.com/v1/media/view/{media_ID}’
Sample response:
{ "assign_notified": false, "_id": "591ad5c89213ce3775150132", "title": "test media", "extension": "mp3", "service_options": { "id": "591abd079213ce19643e9b57", "turnaround": "48 hour", "document": "XML", "speakers": "2-3 Speakers", "timestamps": "Not Required", "name": "Summary" }, "project_id": "58fff3519213ce55a678ef97", "user_id": "562f692a05dfe9560fb6e428", "status": "pending", "quality": "normal", "short_id": 2, "created_at": 1494930888, "updated_at": 1494930888, "client_username": "clientuser", "client_email": "clientuser@gmail.com", "file_id": "591ad5c89213ce3775150144", "order_id": "", "transcoding_status": "none", "price": null, "in_sfb_pool": false, "finished_transcript": "", "client_comments": "", "proofreader_username": "" }
Set your callback URL
Authorization(in the header)
Content-Type(in the header)
userID(in the path)
callback_url(in the path)
Bearer {your_token}
application/x-www-form-urlencoded
{user_ID}
{your callback URL}
Instructions:
curl -X PUT -H “Authorization: Bearer {your_token}” -H “Content-Type: application/x-www-form-urlencoded” -H “Cache-Control: no-cache” -d ‘callback_url={your callback URL}‘ “https://api.takenotetyping.com/v1/user/{user_id}“
Sample response:
{ "is_business_account": true, "_id": "562f692a05dfe9560fb6e428", "username": "clientuser", "email": "clientuser@gmail.com", "status": 2, "role": 4, "sharing_token": "", "credit": 0, "discount": 0, "updated_at": 1488375372, "firstname": "", "lastname": "", "callback_url": "test.com", "profile": { "nick_name": "", "alternative_email": "", "security_email": "", "security_question": "", "security_answer": "", "mobile": "", "landline": "", "street": "", "post_code": "", "city": "", "country": "", "company": "", "general_comments": "", "custom_fields": "", "image_id": "58b41a9e6a63d3f31db2a62e", "bio": "", "typist_grade": "", "date_of_birth": "", "utr": "", "contact_email": "", "contact_phone1": "", "contact_phone2": "", "contact_address": "", "image_url": "https://api-dev.takenotetyping.com/view/58b41a9e6a63d3f31db2a62e" }, "service": { "summaries": "", "notes": "", "legal": "", "media": "", "live_notetaking": "" }, "business_information": { "company_name": null, "company_number": null, "vat_number": null, "address": null, "directors": null, "contact_name": null, "contact_email": null, "contact_phone": null, "agreement": null }, "bank_information": { "account_name": "", "method_of_payment": "", "short_code": "", "account_number": "", "utrn_number": "", "registered_address": "" }, "statistics": [], "skills": [], "areas_of_expertise": [], "trophies": [], "training_badges": [], "accents": [], "quickbooks_id": null, "infusionsoft_id": null }
Get a Presigned URL in Order to Upload a Media File
Authorization(in the header)
mediaID(in the path)
Bearer {your_token}
{media_ID}
Instructions:
curl -X GET –header ‘Accept: application/json’ –header ‘Authorization: Bearer {your_token}‘ ‘https://api.takenotetyping.com/v1/media/get-presigned-url?id={media_ID}’
Sample response:
{ "presigned_url": "https://tn-media-input.s3.amazonaws.com/589c7bff6a63d3ea4d292453/ce1352421084f5e81eb1102d5ab02917..mp3?AWSAccessKeyId=AKIAI4A3E3VFCX54JTVA&Expires=1488428087&Signature=H5lxdH0PZY93R4OZ4oajpw06tAc%3D" }
Upload Your Media Using The Given Presigned URL
Content-Type(in the header)
application/octet-stream
curl -X PUT -H “Content-Type: application/octet-stream” -H “Cache-Control: no-cache” “{Presigned AWS URL}“
Sample response:
The response here is empty.
Approve Your Media After Finished Uploading
Authorization(in the header)
mediaID(in the path)
Bearer {your_token}
{media_ID}
Instructions:
curl -X PUT –header ‘Content-Type: application/json’ –header ‘Accept: application/json’ –header ‘Authorization: Bearer {your_token}‘ ‘https://api.takenotetyping.com/v1/media/process/{media_ID}’
Sample response:
{ "assign_notified": false, "_id": "591ad5c89213ce3775150132", "title": "test media", "extension": "mp3", "service_options": { "id": "591abd079213ce19643e9b57", "turnaround": "48 hour", "document": "XML", "speakers": "2-3 Speakers", "timestamps": "Not Required", "name": "Summary" }, "project_id": "58fff3519213ce55a678ef97", "user_id": "562f692a05dfe9560fb6e428", "status": "uploaded", "quality": "normal", "short_id": 2, "created_at": 1494930888, "updated_at": 1494932368, "client_username": "clientuser", "client_email": "clientuser@gmail.com", "file_id": "591ad5c89213ce3775150144", "duration": 107.04, "email_sent_on_transcript_complete": 0, "transcoding_status": "none", "price": 1.25, "fake": "0", "in_sfb_pool": false, "discount": 0, "finished_transcript": "", "poor_audio": 0, "order_id": "", "client_comments": "", "proofreader_username": "" }
Add Your Media File to The Shopping Cart
Authorization(in the header)
media_list[]
Bearer {your_token}
{media_ID}
Instructions:
curl -X POST –header ‘Content-Type: application/x-www-form-urlencoded’ –header ‘Accept: application/json’ –header ‘Authorization: Bearer {your_token}‘ -d ‘media_list%5B0%5D={media_ID}’‘ ‘https://api.takenotetyping.com/v1/cart/add’
Sample response:
{ "_id": "591ac8549213ce35b142fed4", "user_id": "562f692a05dfe9560fb6e428", "status": "pending", "total_price": 1.25, "media_list": [ { "assign_notified": false, "_id": "591ad5c89213ce3775150132", "title": "test media", "extension": "mp3", "service_options": { "id": "591abd079213ce19643e9b57", "turnaround": "48 hour", "document": "XML", "speakers": "2-3 Speakers", "timestamps": "Not Required", "name": "Summary" }, "project_id": "58fff3519213ce55a678ef97", "user_id": "562f692a05dfe9560fb6e428", "status": "uploaded", "quality": "normal", "short_id": 2, "created_at": 1494930888, "updated_at": 1494932368, "client_username": "clientuser", "client_email": "clientuser@gmail.com", "file_id": "591ad5c89213ce3775150144", "duration": 107.04, "email_sent_on_transcript_complete": 0, "transcoding_status": "none", "price": 1.25, "fake": "0", "in_sfb_pool": false, "discount": 0, "finished_transcript": "", "poor_audio": 0, "order_id": "591ac8549213ce35b142fed4", "client_comments": "", "proofreader_username": "" } ], "created_at": 1494927444, "updated_at": 1494932451, "payment_id": null, "infusionsoft_id": null }
Pay Your Order
Authorization(in the header)
order_id
provider
Bearer {your_token}
{order_ID}
{provider}
Options:
curl -X POST –header ‘Content-Type: application/x-www-form-urlencoded’ –header ‘Accept: application/json’ –header ‘Authorization: Bearer {your_token}‘ -d ‘order_id={order_ID}&provider={provider}‘ ‘https://api.takenotetyping.com/v1/payment/create’
Sample response:
{ "_id": { "$id": "58b452d46a63d3bc62b2a62e" }, "provider": "business_account", "trans_id": "", "status": "approved", "created_at": 1488212692, "updated_at": 1488212692, "order_id": "58b2e6346a63d38524d4f739" }
Download Transcript in Different Formats
Authorization(in the header)
media_id (in the path)
document_type (in the path)
Bearer {your_token}
{media_ID}
{document_type}
Options:
document_type
curl -X GET ‘http://api-dev.takenotetyping.com/v1/media/download-product/{media_id}?document_type={document_type}‘ -H ‘Authorization: Bearer {your_token}‘ -H ‘Cache-Control: no-cache’
Sample response:
The response is the transcript file in the requested format.
Before You Upload a Media Create a New Project
Authorization(in the header)
title
is_favorite (optional)
default (optional)
Bearer {your_token}
{project_title}
0 (false) or 1 (true)
0 (false) or 1 (true)
curl -X POST –header ‘Content-Type: application/x-www-form-urlencoded’ –header ‘Accept: application/json’ –header ‘Authorization: Bearer {your_token}‘ -d ‘title={project_title}&is_favorite=1′ ‘https://api.takenotetyping.com/v1/project’
Sample response:
{ "title": "{project_title}", "owner_id": "562f692a05dfe9560fb6e428", "is_favorite": false, "deadline": 1495897153, "status": "active", "default": false, "email_each_transcript_on_complete": 0, "priority": "normal", "created_at": 1488211153, "updated_at": 1488211153, "_id": "58b44cd16a63d3125bb2a62e", "owner_name": "", "members": [] }
Create a New Media File
Authorization(in the header)
title
extension
project ID
service_options[speakers]
service_options[turnaround]
service_options[id]
service_options[document] (optional)
service_options[timestamps] (optional)
Bearer {your_token}
{media_title}
{extension_of_media}
{project_id}
{number_of_speakers}
{required_turnaround_time}
{_id}
{document_type}
{timestamp_options}
Options:
project_id
extension
service_options[speakers]
service_options[turnaround]
service_options[id]
service_options[document] (optional)
service_options[timestamp] (optional)
curl -X POST \ https://api.takenotetyping.com/v1/media/short-create \ -H ‘authorization: {your_token}‘ \ -H ‘cache-control: no-cache’ \ -H ‘content-type: application/x-www-form-urlencoded’ \ -d ‘title={media_title}&project_id={project_id}&extension={extension_of_media}&service_options%5Bid%5D={_id}&service_options%5Bturnaround%5D={required_turnaround_time}&service_options%5Bdocument%5D={document_type}&service_options%5Bspeakers%5D={number_of_speakers}&service_options%5Btimestamps%5D={timestamp_options}‘
Sample response:
{ "assign_notified": false, "title": "test media", "extension": "mp3", "service_options": { "id": "591abd079213ce19643e9b57", "turnaround": "48 hour", "document": "XML", "speakers": "2-3 Speakers", "timestamps": "Not Required", "name": "Summary" }, "project_id": "58fff3519213ce55a678ef97", "user_id": "562f692a05dfe9560fb6e428", "status": "pending", "quality": "normal", "short_id": 2, "created_at": 1494930888, "updated_at": 1494930888, "client_username": "clientuser", "client_email": "clientuser@gmail.com", "_id": "591ad5c89213ce3775150132", "file_id": "591ad5c89213ce3775150144", "order_id": "", "transcoding_status": "none", "price": null, "in_sfb_pool": false, "finished_transcript": "", "client_comments": "", "proofreader_username": "" }
Upload Your Media File Using The Presigned URL
Content-Type(in the header)
application/octet-stream
curl -X PUT -H “Content-Type: application/octet-stream” -H “Cache-Control: no-cache” “{Presigned AWS URL}“
Sample response:
The response here is empty.
Approve Your Media File After Uploading
Authorization(in the header)
mediaID(in the path)
Bearer {your_token}
{media_ID}
Instructions:
curl -X PUT –header ‘Content-Type: application/json’ –header ‘Accept: application/json’ –header ‘Authorization: Bearer {your_token}‘ ‘https://api.takenotetyping.com/v1/media/short-process/{media_ID}’
Sample response:
{ "_id": "591ac7c39213ce19412c54ec", "provider": "business_account", "trans_id": "", "status": "approved", "created_at": 1494927299, "updated_at": 1494927299, "order_id": "591ac7c39213ce19412c54ea" }