Skip to main content
POST
/
voice
/
api
/
v2
/
transaction
/
init
/
{txn_id}
Initialize Transaction
curl --request POST \
  --url https://api.eka.care/voice/api/v2/transaction/init/{txn_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "additional_data": {
    "doctor": {
      "_id": "174097180967921",
      "profile": {
        "personal": {
          "name": {
            "f": "Divyesh",
            "l": ""
          }
        }
      }
    },
    "patient": {},
    "visitid": "09e4f00f-d665-4212-b77c-b2dd5f22bd92_1742560488782"
  },
  "mode": "dictation",
  "input_language": [
    "en-IN"
  ],
  "speciality": "general_medicine",
  "output_format_template": [
    {
      "template_id": "eka_emr_template",
      "language_output": "en-IN",
      "codification_needed": false
    }
  ],
  "transfer": "non-vaded",
  "batch_s3_url": "s3://m-pp-voice2rx/250307/R-S3-195D5131-D014-56A8-ACCF-2F8F2D230DEC/"
}'
{
  "status": "success",
  "message": "Transaction initialized successfully",
  "txn_id": "test_1234",
  "b_id": "b-1234567890"
}

​
Available Template IDs

Eka Care supports multiple output templates for different medical documentation needs. Choose the appropriate template ID based on your requirements:
Template IDDescriptionUse Case
clinical_notes_templateComprehensive clinical notes with structured medical informationGeneral clinical documentation, patient consultations
eka_emr_templateEMR-compatible format for electronic medical recordsIntegration with EMR systems
transcript_templateBasic transcription with minimal structuringSimple audio-to-text conversion

​
Available model types

Model TypeDescription
proOur most accurate model
liteMore performant model for lower latency

​
Supported Input Languages

Eka Care supports transcription in multiple languages. Specify the appropriate language ID in the input_language parameter:
Language IDLanguage Name
en-INEnglish (India)
en-USEnglish (United States)
hiHindi
guGujarati
knKannada
mlMalayalam
taTamil
teTelugu
bnBengali
mrMarathi
paPunjabi

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
txn_id
string
required

Unique Transaction ID - same as passed in presigned URL request

Example:

"test_1234"

Body

application/json
​
mode
enum<string>
required

Processing mode

Available options:
dictation,
consultation
Example:

"dictation"

​
transfer
enum<string>
required

Transfer mode use vaded for pre-processed audio with Voice Activity Detection, non-vaded for raw audio files

Available options:
non-vaded,
vaded
Example:

"non-vaded"

​
batch_s3_url
string
required

Complete S3 URL path where audio files are uploaded. This is constructed by combining:

  • Base S3 URL from presigned response: presigned_url["uploadData"]["url"]
  • Folder path from presigned response: presigned_url["folderPath"]

Construction: presigned_url["uploadData"]["url"] + presigned_url["folderPath"]

Example:

"https://m-prod-ekascribe-batch.s3.amazonaws.com/EC_173210496011417/txn_301/20250617_105524/"

​
client_generated_files
string[]
required

Array of audio file names that were uploaded to S3

Example:
["audio_first.m4a", "audio_second.m4a"]
​
model_type
enum<string>
required

Type of model to be used for transcription

Available options:
pro,
lite
Example:

"pro"

​
additional_data
object

Contextual information for the transaction

Example:
{
  "doctor": {
    "_id": "174097180967921",
    "profile": {
      "personal": { "name": { "f": "Divyesh", "l": "" } }
    }
  },
  "patient": {},
  "visitid": "09e4f00f-d665-4212-b77c-b2dd5f22bd92_1742560488782"
}
​
input_language
enum<string>[]

Array of supported input languages for voice transcription

Example:
["en-IN"]
​
speciality
string

Medical speciality context for better transcription accuracy

Example:

"general_medicine"

​
output_format_template
object[]

Array of template configurations for output format

Example:
[
  {
    "template_id": "eka_emr_template",
    "codification_needed": false
  }
]

Response

Transaction initialized successfully

​
status
string
Example:

"success"

​
message
string
Example:

"Transaction initialized successfully"

​
txn_id
string
Example:

"test_1234"

​
b_id
string
Example:

"b-1234567890"