Transcribe media to text
curl --request POST \
--url https://api.tryhamsa.com/v1/jobs/transcribe \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"mediaUrl": "<string>",
"processingType": "async",
"webhookUrl": "<string>",
"webhookAuth": {
"authKey": "Token",
"authSecret": "Secret"
},
"title": "<string>",
"language": "ar",
"returnSrtFormat": false,
"srtOptions": {
"maxLinesPerSubtitle": 2,
"singleSpeakerPerSubtitle": true,
"maxCharsPerLine": 42,
"maxMergeableGap": 0.3,
"minDuration": 0.7,
"maxDuration": 7,
"minGap": 0.04
}
}
'import requests
url = "https://api.tryhamsa.com/v1/jobs/transcribe"
payload = {
"mediaUrl": "<string>",
"processingType": "async",
"webhookUrl": "<string>",
"webhookAuth": {
"authKey": "Token",
"authSecret": "Secret"
},
"title": "<string>",
"language": "ar",
"returnSrtFormat": False,
"srtOptions": {
"maxLinesPerSubtitle": 2,
"singleSpeakerPerSubtitle": True,
"maxCharsPerLine": 42,
"maxMergeableGap": 0.3,
"minDuration": 0.7,
"maxDuration": 7,
"minGap": 0.04
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
mediaUrl: '<string>',
processingType: 'async',
webhookUrl: '<string>',
webhookAuth: {authKey: 'Token', authSecret: 'Secret'},
title: '<string>',
language: 'ar',
returnSrtFormat: false,
srtOptions: {
maxLinesPerSubtitle: 2,
singleSpeakerPerSubtitle: true,
maxCharsPerLine: 42,
maxMergeableGap: 0.3,
minDuration: 0.7,
maxDuration: 7,
minGap: 0.04
}
})
};
fetch('https://api.tryhamsa.com/v1/jobs/transcribe', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tryhamsa.com/v1/jobs/transcribe",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'mediaUrl' => '<string>',
'processingType' => 'async',
'webhookUrl' => '<string>',
'webhookAuth' => [
'authKey' => 'Token',
'authSecret' => 'Secret'
],
'title' => '<string>',
'language' => 'ar',
'returnSrtFormat' => false,
'srtOptions' => [
'maxLinesPerSubtitle' => 2,
'singleSpeakerPerSubtitle' => true,
'maxCharsPerLine' => 42,
'maxMergeableGap' => 0.3,
'minDuration' => 0.7,
'maxDuration' => 7,
'minGap' => 0.04
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.tryhamsa.com/v1/jobs/transcribe"
payload := strings.NewReader("{\n \"mediaUrl\": \"<string>\",\n \"processingType\": \"async\",\n \"webhookUrl\": \"<string>\",\n \"webhookAuth\": {\n \"authKey\": \"Token\",\n \"authSecret\": \"Secret\"\n },\n \"title\": \"<string>\",\n \"language\": \"ar\",\n \"returnSrtFormat\": false,\n \"srtOptions\": {\n \"maxLinesPerSubtitle\": 2,\n \"singleSpeakerPerSubtitle\": true,\n \"maxCharsPerLine\": 42,\n \"maxMergeableGap\": 0.3,\n \"minDuration\": 0.7,\n \"maxDuration\": 7,\n \"minGap\": 0.04\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.tryhamsa.com/v1/jobs/transcribe")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"mediaUrl\": \"<string>\",\n \"processingType\": \"async\",\n \"webhookUrl\": \"<string>\",\n \"webhookAuth\": {\n \"authKey\": \"Token\",\n \"authSecret\": \"Secret\"\n },\n \"title\": \"<string>\",\n \"language\": \"ar\",\n \"returnSrtFormat\": false,\n \"srtOptions\": {\n \"maxLinesPerSubtitle\": 2,\n \"singleSpeakerPerSubtitle\": true,\n \"maxCharsPerLine\": 42,\n \"maxMergeableGap\": 0.3,\n \"minDuration\": 0.7,\n \"maxDuration\": 7,\n \"minGap\": 0.04\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tryhamsa.com/v1/jobs/transcribe")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mediaUrl\": \"<string>\",\n \"processingType\": \"async\",\n \"webhookUrl\": \"<string>\",\n \"webhookAuth\": {\n \"authKey\": \"Token\",\n \"authSecret\": \"Secret\"\n },\n \"title\": \"<string>\",\n \"language\": \"ar\",\n \"returnSrtFormat\": false,\n \"srtOptions\": {\n \"maxLinesPerSubtitle\": 2,\n \"singleSpeakerPerSubtitle\": true,\n \"maxCharsPerLine\": 42,\n \"maxMergeableGap\": 0.3,\n \"minDuration\": 0.7,\n \"maxDuration\": 7,\n \"minGap\": 0.04\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"jobId": "<string>"
}
}{
"code": 123,
"message": "<string>"
}{
"code": 123,
"message": "<string>"
}{
"code": 123,
"message": "<string>"
}Speech-to-Text Routes
Transcribe Route
POST
/
v1
/
jobs
/
transcribe
Transcribe media to text
curl --request POST \
--url https://api.tryhamsa.com/v1/jobs/transcribe \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"mediaUrl": "<string>",
"processingType": "async",
"webhookUrl": "<string>",
"webhookAuth": {
"authKey": "Token",
"authSecret": "Secret"
},
"title": "<string>",
"language": "ar",
"returnSrtFormat": false,
"srtOptions": {
"maxLinesPerSubtitle": 2,
"singleSpeakerPerSubtitle": true,
"maxCharsPerLine": 42,
"maxMergeableGap": 0.3,
"minDuration": 0.7,
"maxDuration": 7,
"minGap": 0.04
}
}
'import requests
url = "https://api.tryhamsa.com/v1/jobs/transcribe"
payload = {
"mediaUrl": "<string>",
"processingType": "async",
"webhookUrl": "<string>",
"webhookAuth": {
"authKey": "Token",
"authSecret": "Secret"
},
"title": "<string>",
"language": "ar",
"returnSrtFormat": False,
"srtOptions": {
"maxLinesPerSubtitle": 2,
"singleSpeakerPerSubtitle": True,
"maxCharsPerLine": 42,
"maxMergeableGap": 0.3,
"minDuration": 0.7,
"maxDuration": 7,
"minGap": 0.04
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
mediaUrl: '<string>',
processingType: 'async',
webhookUrl: '<string>',
webhookAuth: {authKey: 'Token', authSecret: 'Secret'},
title: '<string>',
language: 'ar',
returnSrtFormat: false,
srtOptions: {
maxLinesPerSubtitle: 2,
singleSpeakerPerSubtitle: true,
maxCharsPerLine: 42,
maxMergeableGap: 0.3,
minDuration: 0.7,
maxDuration: 7,
minGap: 0.04
}
})
};
fetch('https://api.tryhamsa.com/v1/jobs/transcribe', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tryhamsa.com/v1/jobs/transcribe",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'mediaUrl' => '<string>',
'processingType' => 'async',
'webhookUrl' => '<string>',
'webhookAuth' => [
'authKey' => 'Token',
'authSecret' => 'Secret'
],
'title' => '<string>',
'language' => 'ar',
'returnSrtFormat' => false,
'srtOptions' => [
'maxLinesPerSubtitle' => 2,
'singleSpeakerPerSubtitle' => true,
'maxCharsPerLine' => 42,
'maxMergeableGap' => 0.3,
'minDuration' => 0.7,
'maxDuration' => 7,
'minGap' => 0.04
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.tryhamsa.com/v1/jobs/transcribe"
payload := strings.NewReader("{\n \"mediaUrl\": \"<string>\",\n \"processingType\": \"async\",\n \"webhookUrl\": \"<string>\",\n \"webhookAuth\": {\n \"authKey\": \"Token\",\n \"authSecret\": \"Secret\"\n },\n \"title\": \"<string>\",\n \"language\": \"ar\",\n \"returnSrtFormat\": false,\n \"srtOptions\": {\n \"maxLinesPerSubtitle\": 2,\n \"singleSpeakerPerSubtitle\": true,\n \"maxCharsPerLine\": 42,\n \"maxMergeableGap\": 0.3,\n \"minDuration\": 0.7,\n \"maxDuration\": 7,\n \"minGap\": 0.04\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.tryhamsa.com/v1/jobs/transcribe")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"mediaUrl\": \"<string>\",\n \"processingType\": \"async\",\n \"webhookUrl\": \"<string>\",\n \"webhookAuth\": {\n \"authKey\": \"Token\",\n \"authSecret\": \"Secret\"\n },\n \"title\": \"<string>\",\n \"language\": \"ar\",\n \"returnSrtFormat\": false,\n \"srtOptions\": {\n \"maxLinesPerSubtitle\": 2,\n \"singleSpeakerPerSubtitle\": true,\n \"maxCharsPerLine\": 42,\n \"maxMergeableGap\": 0.3,\n \"minDuration\": 0.7,\n \"maxDuration\": 7,\n \"minGap\": 0.04\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tryhamsa.com/v1/jobs/transcribe")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mediaUrl\": \"<string>\",\n \"processingType\": \"async\",\n \"webhookUrl\": \"<string>\",\n \"webhookAuth\": {\n \"authKey\": \"Token\",\n \"authSecret\": \"Secret\"\n },\n \"title\": \"<string>\",\n \"language\": \"ar\",\n \"returnSrtFormat\": false,\n \"srtOptions\": {\n \"maxLinesPerSubtitle\": 2,\n \"singleSpeakerPerSubtitle\": true,\n \"maxCharsPerLine\": 42,\n \"maxMergeableGap\": 0.3,\n \"minDuration\": 0.7,\n \"maxDuration\": 7,\n \"minGap\": 0.04\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"jobId": "<string>"
}
}{
"code": 123,
"message": "<string>"
}{
"code": 123,
"message": "<string>"
}{
"code": 123,
"message": "<string>"
}Authorizations
Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '
Body
application/json
Available options:
Hamsa-General-V2.0, Hamsa-Conversational-V1.0 Available options:
async Authorization header to be sent in this format: Authorization: [authKey] [authSecret]
Show child attributes
Show child attributes
Available options:
ar, en You can override srtOptions default values and send the object only if returnSrtFormat is false.
Show child attributes
Show child attributes
Was this page helpful?
⌘I