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