Get started

The Python SDK requires Python 3.10 or later and has no runtime dependencies outside the standard library.

InstallCopy Anchor Link

Install the SDK from PyPI:

pip install ovok-sdk

Or with uv:

uv add ovok-sdk

pip install ovok-sdk installs final releases only. Release candidates (0.1.0rc<n>) and development builds (0.1.0.dev<N>) are pre-releases on PyPI:

pip install --pre ovok-sdk
pip install "ovok-sdk==0.1.0.dev<N>"

Create a clientCopy Anchor Link

from ovok_sdk import Ovok

ovok = Ovok("https://api.sandbox.ovok.com", "your-tenant")

Each namespace on the client, such as ovok.fhir or ovok.slim, mirrors one area of the Ovok API; the overview lists them. A bad option raises OvokConfigError here, not on the first request.

Sign inCopy Anchor Link

For a user, start a session with ovok.auth.login:

result = ovok.auth.login(profile_type="Patient", email=email, password=password)

For a backend service, pass client_id and client_secret instead; see Authenticate a machine client.

Read API dataCopy Anchor Link

patients = ovok.slim.patients.list({"count": 20})
patient = ovok.slim.patients.retrieve("patient-id")
accounts = ovok.accounts.list()

Paged list methods return a Page; see Page through lists.

Next stepsCopy Anchor Link

• Read the guide for each namespace you use, starting from the overview.
• Handle errors by catching the OvokError subclasses.
• Look up exact signatures in the API reference.