API Documentation
SDK Documentation
Voice Enablement
Transcription Routes
Text to Speech Routes
Real Time Routes
Voice Agents Routes
Voice Agents Conversations Routes
AI Content Routes
Project Routes
API Statistics Routes
Transcription Routes
Transcribe Route
POST
/
v1
/
jobs
/
transcribe
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>",
"model": "Hamsa-General-V2.0",
"language": "ar",
"returnSrtFormat": false,
"srtOptions": {
"maxLinesPerSubtitle": 2,
"singleSpeakerPerSubtitle": true,
"maxCharsPerLine": 42,
"maxMergeableGap": 0.3,
"minDuration": 0.7,
"maxDuration": 7,
"minGap": 0.04
}
}'
{
"success": true,
"message": "<string>",
"data": {
"jobId": "<string>"
}
}
Authorizations
Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token <api-key>'
Body
application/json
Response
200
application/json
Successful response
The response is of type object
.
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>",
"model": "Hamsa-General-V2.0",
"language": "ar",
"returnSrtFormat": false,
"srtOptions": {
"maxLinesPerSubtitle": 2,
"singleSpeakerPerSubtitle": true,
"maxCharsPerLine": 42,
"maxMergeableGap": 0.3,
"minDuration": 0.7,
"maxDuration": 7,
"minGap": 0.04
}
}'
{
"success": true,
"message": "<string>",
"data": {
"jobId": "<string>"
}
}
Assistant
Responses are generated using AI and may contain mistakes.