Human Transcription API
Introduction
Using this transcription API you can submit audio/video files for transcription. We will receive a downloadable file URL from your service and within the given delivery deadline, you will receive a transcription file through webhook.
Quick Start
Click the button below to import all APIs set directly in your Postman account.
Features of API
- List all Available Languages to Transcribe
- Get Language Pairs
- Get Transcription Cost Before Making an Order
- Create an Order With Single/Multiple Files and Get Status ID
- Get an Order Status Using Status ID
How Does Human Transcription API Work?
- Your server sends the URL of audio/video files you want to get transcribed.
- When transcription is finished, myTranscriptionPlace will send the URL of the transcription file back to you on the webhook URL.
- When you make an order, money will be deducted from your prepaid wallet or billed if the postpaid arrangement is made.
Endpoints Description
All endpoints are available via https only and are located at https://mytranscriptionplace.com/transcription-api/. For authorization, please pass auth token provided to you when you sign up for myTranscriptionPlace API in headers as "Authorization". All exchanges will happen in JSON.
Endpoints
List all Languages
GET /languages
Use this API to get a list of all video/audio source languages supported for transcription.
Response
{
"success": true,
"languages": [
"English",
"Albanian",
"Arabic"...
] // Array of list of supported languages
}
List Language Pairs by Language
POST /languagePairs
Use this API to get list of target languages to transcribe video in.
Request
{
"from": "Spanish" // Language name from /languages API data.
}
Response
{
"success": true,
"languages": [
"English",
"Spanish"
] // Array of language pairs
}
Get Transcription Cost
POST /transcriptionCost
Use this API to send file data (example - language & duration) and get the cost before making an order.
Request
{
"from": "Spanish", // Source audio/video language
"to": "English", // Language to transcribe in
"duration": 125, // File duration in minutes
"speaker": "s", // Number of speakers - "s" for 1-2, "m" for > 3 speakers
"turnaround": "h", // Turnaround, supported "h", "m", "l" (high/medium/low priority)
"srt_required": 0 // 0 or 1, interactive transcript is required - 1, otherwise - 0.
}
Response
{
"success": true,
"total": 95, // Transcription cost in USD ($95 here for example only)
"delivery_by": "2021-07-16" // Delivery date (date here for example only)
}
Create an Order
POST /order
Use this API to send file URL(s) and file data (example - language & total duration) and create an order.
Request
{
"from": "Spanish", // Source audio/video language
"to": "English", // Language to transcribe in
"duration": 125, // Total file duration in minutes of multiple files sent
"speaker": "s", // Number of speakers - "s" for 1-2, "m" for > 3 speakers
"turnaround": "h", // Turnaround, supported "h", "m", "l" (high/medium/low priority)
"srt_required": 0, // 0 or 1, interactive transcript is required - 1, otherwise - 0.
"files": [
"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ForBiggerBlazes.mp4",
"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/Sintel.mp4"
] // Array of list of file URLs. A single file can also be sent for transcription.
}
Response
{
"success": true,
"total": 95, // Transcription cost in USD ($95 here for example only)
"delivery_by": "2021-07-16" // Delivery date (date here for example only)
}
Get an Order Status
GET /order/{order_id}
Use this API to get order details with summary.
Request (Path Parameter)Order ID: append the order ID you received when order was created to check current status of your order.
Response
{
"success": true,
"status": "Received", // Can be "Cancelled", "Received", "In Progress", "Completed"
"summary": {
"date": "2022-01-11 10:00:00",
"deadline": "2022-01-13",
"duration": 120,
"speaker": "s",
"total": 78,
"from" => "English",
"to" => "English"
}
}
Note: Look out for "description" if available to know more about order status (for example cancellation reason). You will also get "files" return if the status is "Completed".
Webhook Events
Order Complete
This event is triggered when an order is complete.
Subscription
{
"event": "order.complete",
"payload": {
"order_id": 23, // Order ID you get when making an order
"files": [
"https://mytranscriptionplace.com/download-transcription/ao...",
"https://mytranscriptionplace.com/download-transcription/wf..."
], // Array of list of transcription file downloadable URLs
"from_language", // Language transcribed from
"to_language" // Language transcribed to
}
}
Get API Access
Contact us with your requirements and we will get you onboarded as soon as possible!
© Copyright 2024 All right reserved. Powered By myMRPlace