Take Note 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 three environments:
dev (for testing) : https://api-test.takenotetyping.com
sandbox testing : https://api-sandbox.takenotetyping.com

Each step is avaliable with sandbox testing, have a look at the instructions in this color.

api (production) : https://api.takenotetyping.com

API Login With Getting The Authorisation Token

Post/v1/oauth2/token
We use standard oauth2 methods and in order to access the members area, you have to have an authorisation token.
Authorization(in the header)
username
password
grant_type
Basic dGVzdGNsaWVudDp0ZXN0cGFzcw
{your_username}
{your_password}
password
This step is the same with sandbox testing. You need a client Bearer token in order to use the sandbox testing environment.

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

Post/v1/project
You can organise your media files in projects. These projects act like folders on your pc.
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

Post/v1/media/create
Media file needs to be initiated with the following options:
Authorization(in the header)
title
extension
project ID
service_parameters[nr_of_speakers]
service_options[speakers]
service_parameters[turnaround_time]
service_options[turnaround]
service_parameters[service]
service_options[id]
document_format (optional)
document_extension (optional)
service_options[document]
service_options[timestamps]
client_comments(optional)
Bearer {your_token}
{media_title}
{extension_of_media}
{project_id}
{number_of_speakers}
{number_of_speakers}
{required_turnaround_time}
{required_turnaround_time}
{required_service}
{_id or short_name}
SUBTITLE_OR_CAPTION
XML
XML
{timestamp_options}
{your_comments}

Options:

extension
The extension of your file without the dot.
service_parameters[nr_of_speakers service_options[speakers]
Number of speaker(s) in your media file NR_OF_SPEAKERS_1 (1 speaker), NR_OF_SPEAKERS_2_3 (2-3 speakers) or NR_OF_SPEAKERS_4_PLUS (more than 4 speakers) 1 (Dictation), 2-3 Speakers, 4+ Speakers
service_parameters[turnaround_time] service_options[turnaround]
Turnaround time TT_12HR (12 hour), TT_24HR (24 hour), TT_48HR (48 hour), TT_7DAY (7 days) 12 hour, 24 hour, 48 hour
service_parameters[service] service_options[id]
The following service types are available: SUMMARY_INC_QUOTES, SUMMARY, NOTES, NOTES_AND_QUOTES, FULL_TRANSCRIPTION, INTELLIGENT_VERBATIM, CAPTION _id or short_name You can get it from

here.

document_format (optional)
Here you can specify various different type of format. SUBTITLE_OR_CAPTION
document_extension (optional) service_options[document]
Output format of the transcription. These are the options: XML Plain text, Word, XML
service_options[timestamp]
Timestamp option for the transcription: Not Required, Every Speaker
This step is the same with sandbox testing.

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 or short_name}&service_options%5Bturnaround%5D={required_turnaround_time}&service_options%5Bdocument%5D=XML&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

Get/v1/user/profile
Get all of your profile settings.
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

Get/v1/project
You can see the full 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

Get/v1/media/list-my-media
You can see the full 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

Get/v1/new-service
You can see the full list of 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

Get/v1/media/view/{mediaID}
You can list the details of one of your media files.
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

PUT/v1/user/{userID}
You can set an URL, where you will get status updates about your media.
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:

When you set you callback_url the API will send you automatic HTTP POST response each time your media status is changed. In the response you will get two field title (your media title) and status. The status field can have the following options: uploaded if you file successfully uploaded, ordered if you file successfully ordered, assigned if you file assigned to a typist, done if you file is finished and returned if you transcript is ready to download. Your URL have to send back a HTTP 200 response.

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

Get/v1/media/get-presigned-url?id={media-id}
You can find the temporary URL in the response and this is the URL that will be used to upload your media file.
Authorization(in the header)
mediaID(in the path)
Bearer {your_token}
{media_ID}

Instructions:

You will get a presigned URL in the response and use this to upload the file which has to be in the body in binary format, but don’t forget to set the content type in the header: Content-Type : application/octet-stream
This step returns with 406 code.

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

PUT{Presigned AWS URL}
Using the presigned AWS URL you can upload your media here. You have to set the Content-type in the header to application/octet-stream.
Content-Type(in the header)
application/octet-stream
You don't have to upload any media as the test is using a fake media file.

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

PUT/v1/media/process/{mediaID}
In order to finalise your upload, you have to approve your media file when the upload process has been successfully finished.
Authorization(in the header)
mediaID(in the path)
Bearer {your_token}
{media_ID}

Instructions:

Use your {media_ID}.
You can do this step in the sandbox environment.

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

POST/v1/cart/add
You can add one or multiple media to your shopping cart.
Authorization(in the header)
media_list[]
Bearer {your_token}
{media_ID}

Instructions:

Add one media file using the media ID in the following way : media_lis[0]: {mediaID} , or multiple media files: media_lis[0]: {mediaID}, media_lis[1]: {mediaID}, media_lis[2]: {mediaID}. You will get an order ID in the response, you will need it to fulfill your order.
This step is the same with sandbox testing.

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

POST/v1/payment
You can pay your media files using the shopping cart.
Authorization(in the header)
order_id
provider
Bearer {your_token}
{order_ID}
{provider}

Options:

If you have a business account you can pay using the following value: business_account or use your credit card details: {data comes later}.
This step is the same with sandbox testing.

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

GET/v1/transcript/export/{mediaID}
You can download your transcript when it has been transcribed and the status has been changed to returned.
Authorization(in the header)
media_id
Bearer {your_token}
{media_ID}
This step is the same with sandbox testing, but you will get back a fake media transcript.

curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer {your_token}' 'https://api.takenotetyping.com/v1/transcript/export/{media_ID}'

Sample response:

The response is the transcript file in the requested format.

Download Transcript in XML Format

GET/v1/speech-to-text/{s2t_document_id}
You can download your transcript when it has been transcribed and the status has been changed to returned. You have to get your s2t_documnet_id from this end point: /v1/media/{mediaID}
Authorization(in the header)
s2t_document_id
Bearer {your_token}
{s2t_document_id}
This step is the same with sandbox testing, but you will get back a fake media transcript in XML format.

curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer {your token}' 'https://api.takenotetyping.com/v1/speech-to-text/{s2t_document_id}'

Sample response:

The response is the transcript file in XML format.

3 Step Quick File Upload

Before You Upload a Media Create a New Project

Post/v1/project
You can organise your media files in projects. These projects act like folders on your pc. You have to create project only ONCE and keep the project ID(s) and use them every time when you upload a media.
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": []
}

Step 1

Create a New Media File

Post/v1/media/short-create
Media file needs to be initiated with the following options:
Authorization(in the header)
title
extension
project ID
service_parameters[nr_of_speakers]
service_options[speakers]
service_parameters[turnaround_time]
service_options[turnaround]
service_parameters[service]
service_options[id]
document_format (optional)
document_extension (optional)
service_options[document]
service_options[timestamps]
client_comments(optional)
Bearer {your_token}
{media_title}
{extension_of_media}
{project_id}
{number_of_speakers}
{number_of_speakers}
{required_turnaround_time}
{required_turnaround_time}
{required_service}
{_id or short_name}
SUBTITLE_OR_CAPTION
XML
XML
{timestamp_options}
{your_comments}

Options:

extension
The extension of your file without the dot.
service_parameters[nr_of_speakers service_options[speakers]
Number of speaker(s) in your media file NR_OF_SPEAKERS_1 (1 speaker), NR_OF_SPEAKERS_2_3 (2-3 speakers) or NR_OF_SPEAKERS_4_PLUS (more than 4 speakers) 1 (Dictation), 2-3 Speakers, 4+ Speakers
service_parameters[turnaround_time] service_options[turnaround]
Turnaround time TT_12HR (12 hour), TT_24HR (24 hour), TT_48HR (48 hour), TT_7DAY (7 days) 12 hour, 24 hour, 48 hour
service_parameters[service] service_options[id]
The following service types are available: SUMMARY_INC_QUOTES, SUMMARY, NOTES, NOTES_AND_QUOTES, FULL_TRANSCRIPTION, INTELLIGENT_VERBATIM, CAPTION _id or short_name You can get it from

here.

document_format (optional)
Here you can specify various different type of format. SUBTITLE_OR_CAPTION
document_extension (optional) service_options[document]
Output format of the transcription. These are the options: XML Plain text, Word, XML
service_options[timestamp]
Timestamp option for the transcription: Not Required, Every Speaker

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}&extension={extension_of_media}&service_options%5Bid%5D={_id or short_name}&service_options%5Bturnaround%5D={required_turnaround_time}&service_options%5Bdocument%5D=XML&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": ""
}

Step 2

Upload Your Media File Using The Presigned URL

PUT{Presigned AWS URL}
Using the presigned AWS URL you can upload your media here. You have to set the Content-type in the header to application/octet-stream
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.

Step 3

Approve Your Media File After Uploading

PUT/v1/media/short-process/{mediaID}
You have to approve your media file after the upload using your {media_ID}.
Authorization(in the header)
mediaID(in the path)
Bearer {your_token}
{media_ID}

Instructions:

Approve the uploaded media file when the file has been successfully uploaded to the server. Afterwards you can download your transcript or, if you requested it your XML transcript.

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"
}