v1

latestOpenAPI 3.0.1MIT2026-07-26104203277.0 KB

Create Job

Create a transcription job.

post/v2/jobs

Request body

type'TRANSCRIPTION' required

apiKeystring uuid required

mediaUrlstring uri required

titlestring required

language'ar' | 'en' required

Language code for the media being transcribed

processingType'async' | 'sync'

webhookUrlstring uri

Example request

{
  "type": "TRANSCRIPTION",
  "apiKey": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "mediaUrl": "https://example.com/audio.mp3",
  "title": "Meeting Notes",
  "language": "ar",
  "processingType": "async",
  "webhookUrl": "https://webhook.site/123",
  "webhookAuth": {
    "authKey": "key123",
    "authSecret": "secret456"
  }
}

Response

Successful response with job id

successboolean

messagestring

messageKeystring

Example response

{
  "success": true,
  "message": "Transcription started, you will receive en email when it's ready",
  "messageKey": "OPERATION_SUCCESSFUL",
  "data": {
    "jobId": "ed9b5601-f731-441a-8500-d9fc7610ef8f"
  }
}