Skip to main content
POST
POST samples instances_preupload
For situations where you’d like to create Samples on the One Codex Platform, but your NGS data is not yet available, we support a “pre-upload” workflow. Simply POST to the /preupload route to receive a unique sample ID. That sample ID may be then passed when uploading your data (see Starting an Upload) to upload data for the pre-uploaded sample instead of creating a new sample. Samples created via the /preupload route will have a visibility property with a value awaiting data. These samples and their metadata will be private, though they may be shared with other accounts if associated with a project at creation time (see Sharing & Projects for more details on sharing data via projects).

Authorizations

X-API-Key
string
header
required

Body

application/json
metadata
InlineMetadata · object | null
project
object | null

An optional project.

tags
InlineTag · object[]

Response

200 - application/json

OK

sample_id
string
required

The sample ID. Use to confirm the upload.