@ohm_studio/sdk

OHM Studio SDK for JavaScript / TypeScript / React — turn voice into structured clinical JSON, FHIR-ready, multi-language. Works in the browser, Node 18+, and Next.js (server actions, route handlers, edge runtime).

For React Native, install @ohm_studio/sdk-react-native instead.

Install

npm install @ohm_studio/sdk
# or
pnpm add @ohm_studio/sdk
# or
yarn add @ohm_studio/sdk

Quickstart

import { OHM } from "@ohm_studio/sdk";

const ohm = new OHM({
  apiKey: process.env.OHM_API_KEY!,           // ohms_live_* or ohms_test_*
  baseUrl: "https://api.ohm.doctor",          // override for self-host
});

// Text → structured JSON
const { data } = await ohm.extract({
  apiSlug: "opd-clinic",
  text: transcript,
});

// Audio → structured JSON in one call
const { transcript, data } = await ohm.audio.extract({
  apiSlug: "opd-clinic",
  file: blob,                                 // File / Blob / { buffer, name?, type? }
});

// Summarize free text — patient / handover / executive / progress-note
const { summary } = await ohm.summarize({
  text: longConsult,
  style: "patient",
  maxLines: 5,
});

React hooks

import { OHM } from "@ohm_studio/sdk";
import { OhmProvider, useOhmAudioExtract } from "@ohm_studio/sdk/react";

const ohm = new OHM({ apiKey: process.env.NEXT_PUBLIC_OHM_TEST_KEY });

export default function App({ children }) {
  return <OhmProvider client={ohm}>{children}</OhmProvider>;
}

function Recorder() {
  const { mutateAsync, data, isPending, error } = useOhmAudioExtract({
    apiSlug: "opd-clinic",
  });
  // ...
}

Error handling

import {
  OHMAuthError,
  OHMRateLimitError,
  OHMValidationError,
} from "@ohm_studio/sdk";

try {
  await ohm.extract({ apiSlug: "opd", text });
} catch (e) {
  if (e instanceof OHMRateLimitError) await sleep(e.retryAfterSec! * 1000);
  if (e instanceof OHMAuthError)        rotateKey();
  if (e instanceof OHMValidationError)  showFieldErrors(e.fields);
}

Bundle size

@ohm_studio/sdk core ships < 25 KB gzipped. React hooks subentry adds ~3 KB. Zero polyfills for Node 18+ / modern browsers.

Documentation

Full reference, cookbook, and OpenAPI playground: docs.ohm.doctor

License

MIT