Vulavula Logo
Vulavula Transcription API

Endpoint:https://vulavula-services.lelapa.ai

Transcribe an audio file (received as a file) in one request

POST
https://vulavula-services.lelapa.ai
/v1/transcribe/sync

Transcribe an audio file (received as a file) in one request › query Parameters

  • lang_code
  • diariseboolean

    Enable diarisation

    Enable diarisation

    Default: false
  • detect_musicboolean

    Enable music detection

    Enable music detection

    Default: false

Transcribe an audio file (received as a file) in one request › Request Body

  • filestring · binary · required

Transcribe an audio file (received as a file) in one request › Responses

Successful Response

  • id
  • upload_file_size
  • audio_length_seconds
  • sample_rate
  • channels
  • frame_rate
  • mime_type
  • language_code
  • diarisation_result
  • transcription_text
  • transcription_status
  • error_message
  • status_datetime
  • upload_datetime
  • warnings

List all the batches that have been created

GET
https://vulavula-services.lelapa.ai
/v1/transcribe/batch

List all the batches that have been created › Responses

Successful Response

  • statusstring · required
  • id
  • keychain_id

    Keychain ID.

  • language_code
  • created_at
  • updated_at

Request a container to upload files for bulk processing

POST
https://vulavula-services.lelapa.ai
/v1/transcribe/batch

Request a container to upload files for bulk processing › Responses

Successful Response

  • batch_idstring · required
  • blob_endpointstring · required
  • sas_tokenstring · required

Kick off the transcription process for a batch of files

POST
https://vulavula-services.lelapa.ai
/v1/transcribe/batch/{id}/process

Kick off the transcription process for a batch of files › path Parameters

  • idstring · required

Kick off the transcription process for a batch of files › query Parameters

  • lang_code

    Language of audio if known. Choose: zul, sot, eng, afr, fra

    Language of audio if known. Choose: zul, sot, eng, afr, fra

  • diariseboolean

    Enable diarisation

    Enable diarisation

    Default: false

Kick off the transcription process for a batch of files › Responses

Successful Response

No data returned

Get more details of a specific batch

GET
https://vulavula-services.lelapa.ai
/v1/transcribe/batch/{id}

Get more details of a specific batch › path Parameters

  • idstring · required

Get more details of a specific batch › Responses

Successful Response

  • statusstring · required
  • id
  • keychain_id

    Keychain ID.

  • language_code
  • created_at
  • updated_at

List all the transcripts in a batch

GET
https://vulavula-services.lelapa.ai
/v1/transcribe/batch/{id}/transcriptions

List all the transcripts in a batch › path Parameters

  • idstring · required

List all the transcripts in a batch › Responses

Successful Response

  • id
  • upload_file_size
  • audio_length_seconds
  • sample_rate
  • channels
  • frame_rate
  • mime_type
  • language_code
  • diarisation_result
  • transcription_text
  • transcription_status
  • error_message
  • status_datetime
  • upload_datetime
  • warnings

Get usage statistics for the customer

GET
https://vulavula-services.lelapa.ai
/v1/transcribe/usage

GET TRANSCRIBE USAGE

Accepts a start date, end date, and interval and returns usage statistics for the customer.

Args

  • start_date_time: start date and time in ISO format (YYYY-MM-DDTHH:MM:SSZ)
  • end_date_time: end date and time in ISO format (YYYY-MM-DDTHH:MM:SSZ)
  • interval: interval for aggregating data (e.g., 'minute', 'hour', 'day')

Returns

  • TranscribeUsageReport: a report containing usage statistics for the customer

Raises

  • HTTPException 400: if the date format is invalid | if the interval is invalid | if the start date is after the end date

Get usage statistics for the customer › query Parameters

  • start_date_timestring · required

    Start date and time in ISO format (YYYY-MM-DDTHH:MM:SSZ)

    Start date and time in ISO format (YYYY-MM-DDTHH:MM:SSZ)

  • end_date_timestring · required

    End date and time in ISO format (YYYY-MM-DDTHH:MM:SSZ)

    End date and time in ISO format (YYYY-MM-DDTHH:MM:SSZ)

  • intervalstring · required

    Interval for aggregating data (e.g., 'minute', 'hour', 'day')

    Interval for aggregating data (e.g., 'minute', 'hour', 'day')

Get usage statistics for the customer › Responses

Successful Response

  • total_invocationsinteger · required
  • total_successful_invocationsinteger · required
  • total_failed_invocationsinteger · required
  • total_pending_invocationsinteger · required
  • total_seconds_transcribednumber · required
  • total_tokensinteger · required
  • start_date_timestring · required
  • end_date_timestring · required
  • intervalstring · required
  • usageobject[]
    Default: []