This guide explains how to integrate the Eka Care Ekascribe Typescript SDK into your application.
The Eka Care Ekascribe SDK allows you to capture and process audio, generating structured medical documentation using Eka Care's voice transcription API.
Before getting started, ensure you have:
- Node 14 or higher
npmoryarnfor dependency management- Access and refresh tokens from Eka Care (optional for some methods)
- Microphone access via browser permissions
- Stable network connectivity
Install the SDK using npm or yarn:
npm install @eka-care/ekascribe-ts-sdk
# or
yarn add @eka-care/ekascribe-ts-sdkThe SDK uses a SharedWorker for background audio uploads. Modern bundlers (Webpack 5, Vite) automatically handle the worker bundling.
Works out of the box - no configuration needed.
// Just import and use
import { getEkaScribeInstance } from '@eka-care/ekascribe-ts-sdk';Works out of the box with default configuration. The new URL(..., import.meta.url) pattern is natively supported.
import { getEkaScribeInstance } from '@eka-care/ekascribe-ts-sdk';For Next.js projects, ensure the SDK is only used on the client side:
'use client';
import { getEkaScribeInstance } from '@eka-care/ekascribe-ts-sdk';
// Use inside a client component
const ekascribe = getEkaScribeInstance({ access_token: 'your_token' });For direct browser usage without a bundler:
<script type="module">
import { getEkaScribeInstance } from 'https://cdn.jsdelivr.net/npm/@eka-care/ekascribe-ts-sdk/dist/index.mjs';
const ekascribe = getEkaScribeInstance({ access_token: 'your_token' });
</script>Get the SDK instance once and use it everywhere in your application to call all methods.
// Create a config variable to manage tokens
const sdkConfig = {
access_token: '<your_access_token>',
};
// Get instance and use it throughout your application
const ekascribe = getEkaScribeInstance(sdkConfig);Important: Use this same ekascribe instance for all SDK method calls.
Get supported input languages, output formats, and consultation modes.
const config = await ekascribe.getEkascribeConfig();{
"data": {
"supported_languages": [
{ "id": "en", "name": "English" },
{ "id": "hi", "name": "Hindi" }
],
"supported_output_formats": [{ "id": "clinical-notes-template", "name": "Clinical Notes" }],
"consultation_modes": [
{
"id": "consultation",
"name": "Consultation",
"desc": "Eka Scribe will listen to your conversation and create clinical notes"
}
],
"max_selection": {
"supported_languages": 2,
"supported_output_formats": 2,
"consultation_modes": 1
},
"user_details": {
"fn": "Dr. John",
"mn": "",
"ln": "Doe",
"dob": "1985-06-15",
"gen": "M",
"s": "active",
"is_paid_doc": true,
"uuid": "user-uuid-123"
},
"wid": "workspace-id-456"
},
"message": "Configuration fetched successfully",
"code": 200
}Initialize a transaction before starting recording. This sets up the session with your configuration.
const response = await ekascribe.initTransaction({
mode: 'consultation',
input_language: ['en-IN'],
output_format_template: [{ template_id: 'your_template_id' }],
txn_id: 'unique-transaction-id',
transfer: 'vaded' | 'non-vaded',
model_type: 'pro' | 'lite',
system_info: {
platform: 'web',
language: 'en',
time_zone: 'Asia/Kolkata',
},
patient_details: {
username: 'John Doe',
age: 35,
biologicalSex: 'M',
},
version: '1.0.0',
additional_data: {},
});Key Parameters:
-
input_language: Language code array (e.g.,['en-IN']) -
output_format_template: Array withtemplate_id- depends on your end user's template selection -
system_info: Optional - Pass your system configuration to backend -
patient_details: Optional - Patient information -
version: SDK version -
additional_data: Optional - Pass any data you want to receive unchanged in the response -
transfer: Audio mode. Usevadedfor audio already processed with Voice Activity Detection (SDK does this by default); usenon-vadedonly if you are sending raw audio without VAD. -
model_type: Transcription model choice.pro= most accurate;lite= lower latency, more performant.
{
error_code?: ERROR_CODE,
status_code: 200,
message: "Transaction initialized successfully",
business_id: "biz_abc123def456",
txn_id: "abc-123",
oid: "org_789xyz",
uuid: "user_uuid_456"
}Error handling:
Possible Error Codes in error_code:
txn_limit_exceeded: Maximum number of transactions exceededtxn_init_failed: Something went wrong. Retry with the same method call
Handling 401 Status Code:
If you receive a status_code: 401, update the tokens in your config and reinitialize the instance:
// Update tokens in your config variable
sdkConfig.access_token = '<new_access_token>';
// Update tokens in the instance
ekascribe.updateAuthTokens({ access_token: sdkConfig.access_token });
// Now you can retry the method call
const response = await ekascribe.initTransaction({ ... });Start recording audio after initializing the transaction.
const response = await ekascribe.startRecording();{
"status_code": 200,
"message": "Recording started successfully",
"txn_id": "abc-123",
// Possible error codes:
// - "microphone" -> microphone permission not granted
// - "vad_not_initialized" -> VAD failed to initialize; reinitialize and retry the same function call
error_code?: ERROR_CODE
}Pause the ongoing voice recording.
const response = await ekascribe.pauseRecording();{
"status_code": 200,
"message": "Recording paused successfully",
"is_paused": true,
error_code?: ERROR_CODE,
}Resume a paused recording.
const response = await ekascribe.resumeRecording();{
"status_code": 200,
"message": "Recording resumed successfully",
"is_paused": false,
error_code?: ERROR_CODE,
}End the recording session. This method:
- Stops the recording
- Uploads all audio chunks to the server
- Automatically retries failed uploads once
- Calls the commit API to finalize the transaction
const response = await ekascribe.endRecording();{
"status_code": 200,
"message": "Recording ended and files uploaded successfully",
failed_files?: ['1.mp3', '2.mp3'], // Only present if some files failed to upload
total_audio_files?: ['1.mp3', '2.mp3', '3.mp3', '4.mp3'], // List of all audio files generated
error_code?: ERROR_CODE;
}Error handling:
Possible Error Codes in error_code:
txn_stop_failed: CallendRecordingagain.audio_upload_failed: UseretryUploadRecording(step 9).txn_commit_failed: CallcommitTransactionCall(step 11).
Handling 401 Status Code:
If you receive a status_code: 401, update the tokens in your config and retry:
// Update tokens in your config variable
sdkConfig.access_token = '<new_access_token>';
// Update tokens in the instance
ekascribe.updateAuthTokens({ access_token: sdkConfig.access_token });
// Now retry the method call
const response = await ekascribe.endRecording();You can fetch output in two ways:
getTemplateOutput({ txn_id }): polling is your responsibility; call repeatedly until processing finishes.pollSessionOutput({ txn_id, max_polling_time }): SDK polls for you and resolves when processing finishes (default max wait: 2 minutes; override viamax_polling_time, pass time in milliseconds).
Example (manual polling):
const res = await ekascribe.getTemplateOutput({ txn_id: 'transaction-id' });Example (SDK-managed polling):
// Waits up to 2 minutes by default; override as needed
const res = await ekascribe.pollSessionOutput({
txn_id: 'transaction-id',
max_polling_time: 2 * 60 * 1000, // optional
});Status codes to handle:
-
200: Success; all templates processed. -
202: Templates are still processing; poll again (or letpollSessionOutputcontinue). -
206: Partial success; some templates not processed fully. -
500: All template processing failed, or internal server error; stop and surface error.
{
response?: {
data: {
output: TOutputSummary[];
template_results: {
integration: TOutputSummary[];
custom: TOutputSummary[];
transcript: TOutputSummary[];
};
audio_matrix?: {
quality: string;
};
additional_data?: {};
created_at?: string;
};
error?: {
code: string;
msg: string;
};
} | null;
status_code: number;
message?: string;
}
type TOutputSummary = {
template_id: string;
value?: JSON | Array | string;
type: string;
name: string;
status: 'success' | 'partial_success' | 'failure';
errors?: Array<{
type: 'warning' | 'error';
code?: string;
msg: string;
}>;
warnings?: Array<{
type: 'warning' | 'error';
code?: string;
msg: string;
}>;
};{
status_code: 200,
response: {
data: {
output: [
{
template_id: "template_id_passed_in_initTransaction",
value: "Output Data for this template",
type: "custom",
name: "General Prescription",
status: "success"
}
],
template_results: {
custom: [
{
template_id: "custom_template",
value: "Output prescription",
type: "custom",
name: "Custom Medication Template",
status: "partial_success",
warnings: [
{
type: "warning",
code: "FIELD_MISSING",
msg: "Dosage information not found"
}
]
}
]
},
audio_matrix: {
quality: "4.5"
},
created_at: "2024-11-19T10:30:00Z"
}
}
}Retry uploading failed audio files after endRecording.
const response = await ekascribe.retryUploadRecording({ force_commit: true });{
"status_code": 200,
"message": "All files uploaded successfully after retry",
error_code?: ERROR_CODE;
failed_files?: ['1.mp3', '2.mp3'];
total_audio_files?: ['1.mp3', '2.mp3', '3.mp3', '4.mp3'];
}force_commit behavior:
force_commit: true- Model will initiate the processing if some files still fail after retryforce_commit: false- It will waits until all files are uploaded successfully before processing.
Handling 401 Status Code:
If you receive a status_code: 401, update the tokens in your config and retry:
// Update tokens in your config variable
sdkConfig.access_token = '<new_access_token>';
// Update tokens in the instance
ekascribe.updateAuthTokens({ access_token: sdkConfig.access_token });
// Now retry the method call
const response = await ekascribe.retryUploadRecording({ force_commit: true });Cancel or update the status of a recording session.
const response = await ekascribe.patchSessionStatus({
sessionId: 'abc-123', // txn_id of the session you want to cancel
processing_status: 'cancelled', // pass exactly this value
processing_error: {
error: {
// Pass these exact values without changing them
type: 'user_action',
code: 'cancelled_by_user',
msg: 'Session cancelled by user',
},
},
});{
"status": "success",
"message": "Session status updated successfully",
"code": 200,
error?: {
code: string;
message: string;
display_message: string;
};
}Handling 401 Status Code:
If you receive a code: 401, update the tokens in your config and retry:
// Update tokens in your config variable
sdkConfig.access_token = '<new_access_token>';
// Update tokens in the instance
ekascribe.updateAuthTokens({ access_token: sdkConfig.access_token });
// Now retry the method call
const response = await ekascribe.patchSessionStatus({ ... });Call this if endRecording returns error_code: 'txn_commit_failed' or the transaction is not yet committed.
const response = await ekascribe.commitTransactionCall();{
error_code?: ERROR_CODE;
status_code: number;
message: string;
};Handling 401 Status Code:
If you receive a status_code: 401, update the tokens in your config and retry:
// Update tokens in your config variable
sdkConfig.access_token = '<new_access_token>';
// Update tokens in the instance
ekascribe.updateAuthTokens({ access_token: sdkConfig.access_token });
// Now retry the method call
const response = await ekascribe.commitTransactionCall();Use this method to stop a transaction that has not yet been stopped or returned a txn_stop_failed error in a previous step.
const response = await ekascribe.stopTransactionCall();{
error_code?: ERROR_CODE;
status_code: number;
message: string;
};Handling 401 Status Code:
If you receive a status_code: 401, update the tokens in your config and retry:
// Update tokens in your config variable
sdkConfig.access_token = '<new_access_token>';
// Update tokens in the instance
ekascribe.updateAuthTokens({ access_token: sdkConfig.access_token });
// Now retry the method call
const response = await ekascribe.stopTransactionCall();Fetch previous sessions. txn_count controls how many sessions the API returns.
const sessions = await ekascribe.getSessionHistory({ txn_count: 10 }); // txn_count = number of sessions to fetch{
data: [
{
b_id: "7174661713699045", // business ID
created_at: "2025-12-10T10:28:00Z",
mode: "consultation",
oid: "174661713843153", // logged-in doctor's org ID
patient_details: { // present only if sent in initTransaction
"age": 18,
"biologicalSex": "M",
"username": ""
},
// processing_status can be: success | system_failure | request_failure | cancelled | in-progress
processing_status: "in-progress",
txn_id: "sc-c2e9be8b-46e5-489a-9473-236ddb5b24fb",
// user_status can be: init | commit
user_status: "init",
uuid: "c44fd76d-8de1-4011-aa54-5ddcca140f0f" // logged-in doctor's user ID
}
],
status: "success",
code: 200,
message: "Sessions fetched",
retrieved_count: 1
}Use this method to retrieve all available templates for the current user.
const templates = await ekascribe.getAllTemplates();{
items: [
{
id: "123;
title: "Template Name";
desc: "Template Description";
section_ids: ["section-1", "section-2"];
is_editable: true | false;
}
];
code: number;
error?: { code: string; message: string };
}Use this method to create a new custom template.
const newTemplate = await ekascribe.createTemplate({
title: 'My Custom Template',
desc: 'Description of the template',
section_ids: ['section1', 'section2', 'section3'],
});{
code: number;
msg: string;
template_id?: string;
message?: string;
error?: { code: string; message: string };
}Use this method to update an existing template.
const updatedTemplate = await ekascribe.updateTemplate({
template_id: 'template-123',
title: 'Updated Template Title',
desc: 'Updated description',
section_ids: ['section1', 'section2', 'section4'],
});{
code: number;
msg: string;
template_id?: string;
message?: string;
error?: { code: string; message: string };
}Use this method to delete an existing template.
const deleteResult = await ekascribe.deleteTemplate('template-123');{
code: number;
msg: string;
template_id?: string;
message?: string;
error?: { code: string; message: string };
}Use this method to generate a template using AI with a text prompt.
const formData = new FormData();
formData.append('content', 'Create a cardiology consultation template');
formData.append('file', file);
formData.append('contentType', 'text/file');
const aiTemplate = await ekascribe.aiGenerateTemplate(formData);{
title: string;
desc: string;
sections: [
{
id: string;
title: string;
desc: string;
format: 'P' | 'B';
example: string;
default?: boolean;
parent_section_id?: string;
}
];
code: number;
message: string;
}Use this method to mark templates as favourite templates.
const configUpdate = await ekascribe.updateConfig({
my_templates: ['template1', 'template2'],
});{
auto_download?: boolean;
default_languages?: string[];
my_templates?: string[];
scribe_enabled?: boolean;
msg: string;
code: number;
error?: { code: string; message: string };
}Use this method to retrieve all available template sections.
const sections = await ekascribe.getAllTemplateSections();{
items: [
{
id: string;
title: string;
desc: string;
format: 'P' | 'B';
example: string;
default?: boolean;
parent_section_id?: string;
}
];
code: number;
error?: { code: string; message: string };
}Use this method to create a new section that can be used in templates.
const newSection = await ekascribe.createTemplateSection({
title: 'Chief Complaint',
desc: "Patient's primary concern",
format: 'P', // 'P' for paragraph, 'B' for bullet points
example: 'Patient presents with chest pain for 2 days',
});{
msg: string;
section_id: string;
code: number;
action: 'updated' | 'created_custom';
error?: { code: string; message: string };
}Use this method to update an existing template section.
const updatedSection = await ekascribe.updateTemplateSection({
section_id: 'section-123',
title: 'Updated Chief Complaint',
desc: 'Updated description',
format: 'B',
example: 'Updated example text',
});{
msg: string;
section_id: string;
code: number;
action: 'updated' | 'created_custom';
error?: { code: string; message: string };
}Use this method to delete a template section.
const deleteResult = await ekascribe.deleteTemplateSection('section-123');{
msg: string;
section_id: string;
code: number;
action: 'updated' | 'created_custom';
error?: { code: string; message: string };
}Use this method to upload pre-recorded audio files directly and get transcription output without real-time recording. This is useful when you have existing audio files and want to process them.
What this method does:
- Gets a presigned URL from the server
- Uploads audio files to S3 via presigned URL
- Initializes a transaction with the uploaded files
- Returns the transaction details
const audioFiles = [file1, file2]; // File or Blob objects
const audioFileNames = ['audio1.mp3', 'audio2.mp3'];
const response = await ekascribe.uploadAudioWithPresignedUrl({
action: 'ekascribe-v2', // Pass this exact value without changing
audioFiles,
audioFileNames,
mode: 'consultation',
txn_id: 'unique-transaction-id',
input_language: ['en-IN'],
output_format_template: [{ template_id: 'your_template_id' }],
transfer: 'non-vaded', // Use 'non-vaded' for raw audio files
model_type: 'pro' | 'lite',
system_info: {
platform: 'web',
language: 'en',
time_zone: 'Asia/Kolkata',
},
patient_details: {
username: 'John Doe',
age: 35,
biologicalSex: 'M',
},
version: '1.0.0',
additional_data: {},
});Key Parameters:
-
action: Passekascribe-v2exactly as shown -
audioFiles: Array of File or Blob objects -
audioFileNames: Array of file names corresponding to audio files -
transfer: Usenon-vadedfor raw audio files (not processed with VAD) -
Other parameters: Same as
initTransaction(see step 3)
{
error_code?: ERROR_CODE,
status_code: 200,
message: 'Recording uploaded successfully.',
}Error handling:
Possible Error Codes in error_code:
get_presigned_url_failed: Failed to get presigned URL from server, retry with the same methodaudio_upload_failed: Failed to upload audio files to S3, retry with the same methodtxn_limit_exceeded: Maximum number of transactions exceededtxn_init_failed: Failed to initialize transaction after upload, retry with the same method
Handling 401 Status Code:
If you receive a status_code: 401, update the tokens in your config and retry:
// Update tokens in your config variable
sdkConfig.access_token = '<new_access_token>';
// Update tokens in the instance
ekascribe.updateAuthTokens({ access_token: sdkConfig.access_token });
// Now retry the method call
const response = await ekascribe.uploadAudioWithPresignedUrl({ ... });Use this method to retrieve all the audio files generated for a specific session.
const files = ekascribe.getTotalAudioFiles();['1.mp3', '2.mp3', '3.mp3', '4.mp3'];Use this method to retrieve all the audio files that were uploaded successfully.
const successFiles = ekascribe.getSuccessFiles();['3.mp3', '4.mp3'];Use this method to retrieve all the audio files that failed to upload.
const failedFiles = ekascribe.getFailedFiles();['1.mp3', '2.mp3'];Use this method to reset the EkaScribe instance and clear all stored data.
ekaScribe.resetEkaScribe();Use this method to reinitialize the Voice Activity Detection (VAD) instance.
ekaScribe.reinitializeVad();Use this method to pause the Voice Activity Detection without stopping the recording session.
ekaScribe.pauseVad();Use this method to completely destroy the VAD instance and free up resources.
ekaScribe.destroyVad();Use this method to update the access token when it expires (e.g., when you receive a 401 error).
ekascribe.updateAuthTokens({ access_token: 'new_access_token' });When to use:
- When any API method returns
status_code: 401 - When
eventCallbackreturnserror.code: 401infile_upload_status - Before token expiration to prevent upload failures
This callback provides information about SDK operations. Use it to monitor file uploads, transaction status, AWS configuration, and authentication errors.
ekascribe.onEventCallback((eventData) => {
console.log('Event callback:', eventData);
// Handle different callback types
switch (eventData.callback_type) {
case 'file_upload_status':
// Track audio chunk upload progress
console.log(`Uploaded ${eventData.data?.success}/${eventData.data?.total} chunks`);
break;
case 'transaction_status':
// Monitor transaction lifecycle (init, stop, commit, cancel)
console.log('Transaction update:', eventData.message);
break;
case 'aws_configure_status':
// AWS S3 configuration status
console.log('AWS config:', eventData.status);
break;
case 'authentication_status':
// API authentication errors
console.error('Auth error:', eventData.message);
break;
}
});{
callback_type: 'file_upload_status' | 'transaction_status' | 'aws_configure_status' | 'authentication_status',
status: 'success' | 'error' | 'info',
message: string,
timestamp: string, // ISO timestamp
error?: {
code: number,
msg: string,
details: any
},
data?: {
success?: number, // Number of successfully uploaded chunks
total?: number, // Total number of chunks
is_uploaded?: boolean, // Whether current chunk uploaded successfully
fileName?: string, // Current file name
chunkData?: Uint8Array[], // Audio chunk data for current audiofile
request?: any, // API request details
response?: any // API response details
}
}file_upload_status - Track audio chunk upload progress
Use this to monitor upload progress of audio chunks:
-
status: 'info'- Audio chunk infodata.success: Count of successfully uploaded chunksdata.total: Total chunks generateddata.fileName: Current chunk file namedata.chunkData: Audio data for current chunk
-
status: 'success'- Chunk uploaded successfullydata.success: Updated successful upload countdata.total: Total chunksdata.is_uploaded: true
-
status: 'error'- Chunk upload failederror.code: HTTP error codeerror.msg: Error messageerror.details: Additional error details
-
Status codes to handle:
If
error.code === 401, it means your access token has expired. Update tokens immediately:ekascribe.onEventCallback((eventData) => { if (eventData.callback_type === 'file_upload_status' && eventData.status === 'error') { if (eventData.error?.code === 401) { // Token expired - update it sdkConfig.access_token = '<new_access_token>'; ekascribe.updateAuthTokens({ access_token: sdkConfig.access_token }); } } });
Triggered by Voice Activity Detection (VAD) when user starts or stops speaking.
ekascribe.onUserSpeechCallback((isSpeech) => {
if (isSpeech) {
console.log('User started speaking');
} else {
console.log('User stopped speaking');
}
});| Error Code | Description |
|---|---|
microphone |
Microphone access error (permission denied or unavailable) |
txn_init_failed |
Failed to initialize transaction |
txn_limit_exceeded |
Maximum number of concurrent transactions exceeded |
unknown_error |
An unknown or unclassified error occurred |
txn_stop_failed |
Error occurred while stopping the transaction |
audio_upload_failed |
Audio file upload to server failed |
txn_commit_failed |
Commit call failed for the current transaction |
invalid_request |
Request to SDK was malformed or missing required parameters |
vad_not_initialized |
Voice activity detection engine was not initialized |
no_audio_capture |
No audio was captured during the recording session |
txn_status_mismatch |
Invalid operation due to mismatched transaction status |
This is a continually updated, open source project. Contributions are welcome!
- The SDK internally handles shared worker logic to reduce load on the main thread. Try to execute these functions in the main thread to avoid unnecessary issues.
- Maximum retries for file upload in case of failure.
- Update VAD configurations
- Opus compression of audio files
- Test cases
Refer Ekascribe for SDK implementations.