Skip to main content
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
  }
}
'
{
  "success": true,
  "message": "<string>",
  "data": {
    "jobId": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.tryhamsa.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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
​
mediaUrl
string<uri>
required
​
model
enum<string>
required
Available options:
Hamsa-General-V2.0,
Hamsa-Conversational-V1.0
​
processingType
enum<string>
default:async
Available options:
async
​
webhookUrl
string<uri>
​
webhookAuth
object

Authorization header to be sent in this format: Authorization: [authKey] [authSecret]

​
title
string
​
language
enum<string>
default:ar
Available options:
ar,
en
​
returnSrtFormat
boolean
default:false
​
srtOptions
object

You can override srtOptions default values and send the object only if returnSrtFormat is false.

Response

Successful response

​
success
boolean
​
message
string
​
data
object