A Document is a file of any type that might be associated with a Sample or Analysis. Examples of such files include: FAST5 files form Oxford Nanopore, PDF reports generated by our notebook service, and Excel spreadsheets containing metadata.

Documents uploaded to One Codex are stored securely and can be shared with members of your organization. Uploading Documents requires two direct API calls: one to start the upload, and one to confirm that the upload succeeded. If you need to upload a compressed file over 20GB in size, please contact us for help at support@onecodex.com.

The below table summarizes all of the properties for the Document resource, with the JSON schema type of each property listed below in italics. Details on how to upload, modify, and retrieve Documents follow.

The schema is of type object.