Quick Start

A step by step guide to integrate EkaScribe into your application in just few minutes

We recommend the SDK approach as it simplifies implementation by handling voice activity detection (VAD), audio chunking, uploads, and other complexities, making it easy to plug into your existing workflow.

Step 1: Get Your API Credentials

You need a client_id and client_secret to authenticate with EkaScribe.

1. Create an Eka Account

   Sign up on Eka if you haven’t already.

2. Generate API Credentials

   Go to the Eka Developer Console, navigate to Manage API Credentials, and create a new client.

3. Save Your Credentials

   Copy your client_id and client_secret. Store them securely, the secret won’t be shown again.

4. Get Access Token

   Use the Client Login API to obtain an access token, or use your long live token.

View detailed authentication guide →

---

Step 2: Install the SDK

We recommend the TypeScript SDK for the fastest plug-and-play integration.

npm install @eka-care/ekascribe-ts-sdk
# or
yarn add @eka-care/ekascribe-ts-sdk

---

Step 3: Start Transcribing

Here’s a complete working example to record a consultation and get structured medical notes:

// 1. 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);

// 2. Fetch available configurations (languages, templates, etc.)
const config = await ekascribe.getEkascribeConfig();

// 3. Initialize a transcription session
await ekascribe.initTransaction({
  mode: 'consultation',
  input_language: ['en-IN'],
  output_format_template: [{ template_id: 'your_template_id' }],
  txn_id: 'unique-transaction-id',
  transfer: 'vaded',
  model_type: 'pro',
});

// 4. Start recording - microphone permission will be requested
await ekascribe.startRecording();

// ... consultation happens ...

// 5. Stop recording - SDK handles chunking, upload & commit automatically
await ekascribe.endRecording();

// 6. Get the structured output
const result = await ekascribe.pollSessionOutput({
  txn_id: 'unique-transaction-id',
});

console.log(result);

That’s it. The SDK handles VAD, audio chunking, file uploads, retries, and polling - you just call the methods.

---

Explore Other Integration Options

You can also integrate EkaScribe using other SDKs, REST APIs, or the Chrome Extension.