Skip to content

Simplify Quick Start: remove getConfig step, add TS SDK doc reference #548

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
trilok-yadav wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Simplify Quick Start: remove getConfig step, add TS SDK doc reference #548

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions api-reference/health-ai/ekascribe/quick-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,7 @@ const sdkConfig = {
// 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
// 2. Initialize a transcription session
await ekascribe.initTransaction({
mode: 'consultation',
input_language: ['en-IN'],
Expand All @@ -68,23 +65,23 @@ await ekascribe.initTransaction({
model_type: 'pro',
});

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

// ... consultation happens ...

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

// 6. Get the structured output
// 5. 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.
That's it. The SDK handles VAD, audio chunking, file uploads, retries, and polling - you just call the methods. For error handling, token management, and other details, refer to the complete [TypeScript SDK documentation](/api-reference/health-ai/ekascribe/SDKs/TS-sdk).

---

Expand Down