The Ovok client

@ovok/core exports the current Ovok client. The @ovok/core/next entry remains available for existing imports. Both entries use the same client and talk to the Ovok API directly in Node, browsers and React Native.

This client is also the contract the Java and Python SDKs follow, so the same API names are available in each language's idiom.

Create a clientCopy Anchor Link

import { Ovok } from '@ovok/core';

const ovok = new Ovok({
  baseUrl: 'https://api.sandbox.ovok.com',
  tenantCode: 'your-tenant',
});

Options such as storage, timeoutMs and onUnauthenticated are described in Configure the client. A bad option throws OvokConfigError from the constructor, not from the first request.

NamespacesCopy Anchor Link

Each area of the Ovok API has its own namespace, and each has a guide page:

• ovok.auth and ovok.session: sign-in, registration, passwords, saved accounts and session changes. See also Sign users in.
• ovok.fhir and ovok.realtime: FHIR reads, searches and writes, and websocket subscriptions.
• ovok.patient: the signed-in patient's appointments, care plans, questionnaires, devices and dashboard.
• ovok.measurements: saving and reading measurements, with the offline queue.
• ovok.questionnaires and ovok.questionnaireResponses: $populate, submit and $extract.
• ovok.slim: the care-home dashboard API.
• ovok.signals: Signals enablement, undeliverable residents and the Signals gateway.
• ovok.projects, ovok.accounts and ovok.locales and ovok.localizations.
• ovok.cms and ovok.content.
• ovok.consent, ovok.invites and ovok.sharing.
• ovok.documents, ovok.videoCalls, ovok.ai, ovok.wearables, ovok.email, ovok.bots and ovok.health.

Methods follow Stripe's verbs: list, retrieve, create, update (PUT), patch, delete, and plain verbs such as acknowledge, accept or revoke.

Paging and request optionsCopy Anchor Link

• Paging: lists the server pages return a PagePromise. Await it for the first page, or for await over it for every item.
• Request options: every method takes { signal, timeoutMs } as its last argument.
• Errors: every failure is an OvokError; see Errors and retries.

RuntimesCopy Anchor Link

• Bundlers, React Native and Node: import from @ovok/core.
• Existing imports: @ovok/core/next remains an alias for the same client.
• Deep imports: existing @ovok/core/dist/* imports remain available.
• React Native: use @ovok/native/next, which supplies device storage and the crypto.getRandomValues polyfill that sign-in needs.
• Node: version 22 or later.

ReferenceCopy Anchor Link

• Ovok client API reference and the complete API reference.