# API reference

Canonical page: https://docs.ovok.com/python-sdk/reference

Generated from the `ovok_sdk` docstrings; do not edit these pages by hand. Start with [`ovok_sdk.ovok`](/python-sdk/reference/ovok), the client. Each `ovok.<namespace>` is documented on its module page under `resources`.

- [`ovok_sdk.auth.access_token`](/python-sdk/reference/auth/access_token): OAuth access tokens and their expiry.
- [`ovok_sdk.auth.client_credentials`](/python-sdk/reference/auth/client_credentials): Machine-client authentication with the OAuth client-credentials grant.
- [`ovok_sdk.auth.credentials`](/python-sdk/reference/auth/credentials): The interface that supplies bearer tokens to requests.
- [`ovok_sdk.auth.pkce`](/python-sdk/reference/auth/pkce): PKCE (RFC 7636) verifier and challenge generation.
- [`ovok_sdk.auth.session`](/python-sdk/reference/auth/session): The signed-in user's session and its JSON conversions.
- [`ovok_sdk.auth.session_store`](/python-sdk/reference/auth/session_store): Persistence of the user session in `OvokStorage`.
- [`ovok_sdk.auth.single_flight`](/python-sdk/reference/auth/single_flight): Deduplication of concurrent calls, such as token refreshes.
- [`ovok_sdk.auth.token_endpoint`](/python-sdk/reference/auth/token_endpoint): The OAuth token endpoint.
- [`ovok_sdk.auth.user_session`](/python-sdk/reference/auth/user_session): The signed-in user's session and its token refresh.
- [`ovok_sdk.clock`](/python-sdk/reference/clock): Wall-clock time in epoch milliseconds.
- [`ovok_sdk.config`](/python-sdk/reference/config): Client options, checked once when the client is constructed.
- [`ovok_sdk.errors`](/python-sdk/reference/errors): Errors the SDK raises, one class per kind of failure.
- [`ovok_sdk.http.client`](/python-sdk/reference/http/client): The authenticated JSON client every namespace sends through.
- [`ovok_sdk.http.error_response`](/python-sdk/reference/http/error_response): Conversion of error responses into `OvokError`s.
- [`ovok_sdk.http.request`](/python-sdk/reference/http/request): The description of one API call before it is sent.
- [`ovok_sdk.http.retry`](/python-sdk/reference/http/retry): When and how long to wait before retrying a request.
- [`ovok_sdk.http.transport`](/python-sdk/reference/http/transport): The pluggable transport that sends HTTP requests.
- [`ovok_sdk.http.url`](/python-sdk/reference/http/url): URL path and query encoding.
- [`ovok_sdk.ovok`](/python-sdk/reference/ovok): The `Ovok` client, the entry point to every API namespace.
- [`ovok_sdk.paging`](/python-sdk/reference/paging): Paged results and the loaders for each list format Ovok returns.
- [`ovok_sdk.resources.ai`](/python-sdk/reference/resources/ai): AI features: translation, natural-language FHIR search and chat.
- [`ovok_sdk.resources.auth`](/python-sdk/reference/resources/auth): The `ovok.auth` namespace: sign-in, registration and account management.
- [`ovok_sdk.resources.auth_sessions`](/python-sdk/reference/resources/auth_sessions): The `ovok.auth.sessions` namespace: the account's server-side sessions.
- [`ovok_sdk.resources.bots`](/python-sdk/reference/resources/bots): The `ovok.bots` namespace: run server-side bots.
- [`ovok_sdk.resources.cms`](/python-sdk/reference/resources/cms): Published CMS content for the configured tenant: documents, legal pages and translations.
- [`ovok_sdk.resources.consent`](/python-sdk/reference/resources/consent): The `ovok.consent` namespace: the signed-in user's legal and medical consent.
- [`ovok_sdk.resources.content`](/python-sdk/reference/resources/content): Project-managed CMS content by content type and language.
- [`ovok_sdk.resources.documents`](/python-sdk/reference/resources/documents): Stored documents: uploads, metadata and download links.
- [`ovok_sdk.resources.fhir`](/python-sdk/reference/resources/fhir): Generic FHIR R4 reads, searches, writes and batches.
- [`ovok_sdk.resources.health`](/python-sdk/reference/resources/health): The `ovok.health` namespace: the API health check.
- [`ovok_sdk.resources.invites`](/python-sdk/reference/resources/invites): The `ovok.invites` namespace: create and accept invitations.
- [`ovok_sdk.resources.measurement_builder`](/python-sdk/reference/resources/measurement_builder): Builds FHIR Observations from typed measurement readings.
- [`ovok_sdk.resources.measurements`](/python-sdk/reference/resources/measurements): Measurement building, saving with an offline retry queue, and latest-value reads.
- [`ovok_sdk.resources.patient`](/python-sdk/reference/resources/patient): FHIR reads for the signed-in patient: appointments, measurements, care plans and more.
- [`ovok_sdk.resources.platform`](/python-sdk/reference/resources/platform): Platform administration: accounts, projects, locales, localizations and email templates.
- [`ovok_sdk.resources.questionnaires`](/python-sdk/reference/resources/questionnaires): Questionnaire population and QuestionnaireResponse submission and extraction.
- [`ovok_sdk.resources.registration`](/python-sdk/reference/resources/registration): Sign-up requests for `ovok.auth.register` and `ovok.auth.register_practitioner`.
- [`ovok_sdk.resources.sharing`](/python-sdk/reference/resources/sharing): The `ovok.sharing` namespace: patient record sharing.
- [`ovok_sdk.resources.signals`](/python-sdk/reference/resources/signals): Signals enablement, the proxied Signals API and undeliverable-config repair.
- [`ovok_sdk.resources.slim`](/python-sdk/reference/resources/slim): The `ovok.slim` namespace: Ovok's compact care-facility API for patients, devices and alerts.
- [`ovok_sdk.resources.video_calls`](/python-sdk/reference/resources/video_calls): LiveKit video calls: appointments, access and email notices.
- [`ovok_sdk.resources.wearables`](/python-sdk/reference/resources/wearables): Wearable providers and the signed-in user's connections to them.
- [`ovok_sdk.storage`](/python-sdk/reference/storage): Key-value storage the client keeps its session in.
- [`ovok_sdk.values`](/python-sdk/reference/values): Checks on loosely typed values.