Documents

ovok.documents stores files such as reports and consent forms. It lists and deletes documents, starts uploads, updates metadata and builds download URLs.

Upload a documentCopy Anchor Link

create_upload() creates the document and returns where to upload its file. replace_upload() does the same for a new version of an existing document.

from ovok_sdk import Ovok

ovok = Ovok("https://api.sandbox.ovok.com", "your-tenant")
document = ovok.documents.create_upload({"name": "report.pdf", "contentType": "application/pdf"})

List, update and delete documentsCopy Anchor Link

documents = ovok.documents.list({"patientId": "patient-id"})
ovok.documents.update_metadata("document-id", {"name": "Discharge report"})
ovok.documents.delete("document-id")

Link to a downloadCopy Anchor Link

download_url() and public_download_url() only build the URL; they send no request. A public URL takes the document's share token instead of its ID.

url = ovok.documents.download_url("document-id")
shared = ovok.documents.public_download_url("public-token")

API referenceCopy Anchor Link

See ovok_sdk.resources.documents for every method, parameter and error.