Skip to main content
POST
POST sequencing instances_batches_register
You can let One Codex know about sequencing samples that are inbound to our lab by registering them as part of a Sequencing Batch. A Batch can have one or more samples associated with it, and lets you associate the tube barcodes for the Reformatting or Sample Collection tubes you have with Sample objects in One Codex. The response from this endpoint will give you a list of Samples, each with an identifier and the tube barcode it is associated with. You should store this identifier so that you can update Sample metadata or retrieve the Sample later on.

Authorizations

X-API-Key
string
header
required

Body

application/json
batch_name
string
required

A human-readable name for the sequencing batch.

Required string length: 1 - 100
return_tracking_numbers
string[]
required

One or more tracking numbers associated with the sample shipment(s) to the lab.

Required array length: 1 - 100 elements
samples
_RegisterSampleSchema · object[]
required

The tube barcodes, specimen type, and sequencing depth for each sample to be sequenced.

Required array length: 1 - 5000 elements

Response

200 - application/json

OK

batch
sequencing/batches · object
required

The sequencing batch object that was created.

samples
_TubeAndSampleSchema · object[]
required

The sample object associated with the tube barcode. This will be in an awaiting_data state until the lab has finished processing the physical sample.