Scope
The Reshape API v2 is designed for two main use cases:
Generate plate maps that can be linked to plates for imaging and analysis through a plate label that you provide
Retrieve images, job and analysis data from the jobs you ran on an Imaging Device.
Note that the API does not work with the Quality platform currently.
Getting an API key
In order to access your data through the Reshape API, you need an API key. You can get in touch with your customer consultant that will share your organization's key in a safe way.
API documentation
The API docs can be found here: https://api.reshapebiotech.com/docs
Use cases
Use case 1: Retrieving analysis results
In order to fetch analysis results from Reshape, you need to find the relevant Processed plates that are done analyzing, fetch those Processed plates and Processed wells and their analysis data. When fetching the analysis data, you want to define which lighting preset you want to fetch the results for (analysis data might differ when analyzed with for instance top light versus bottom light).
Relevant endpoints
GET /processed-plates Get a list of Processed plates.
GET /processed-plates/{processedPlateId} Get an individual Processed plate.
GET /processed-plates/{processedPlateId}/processed-wells Get wells on a plate.
GET /processed-plates/{processedPlateId}/processed-wells/{processedWellId}/analyses Get analysis data points available for a processed well.
GET /processed-plates/{processedPlateId}/processed-wells/{processedWellId}/analyses/{analysisId} Get individual analysis data point for a processed well.
Use case 2: Create plates in Reshape
In order to get metadata into Reshape, you need to create a Plate and its Wells with the relevant properties. After creation, the Plate can either be selected when starting a new job or can be linked to an already existing Processed plate.
In order to send and fetch Plates, you need to provide a Reshape Group ID.
Relevant endpoints
POST /plates Create a plate.
POST /plates/{plateId}/wells Create a well and its metadata.
GET /processed-plates Get Processed Plates.
PUT /plates/{plateId} Link a Plate to a Processed Plate.
GET /groups Get groups in your organization.
Use case 3: Downloading images
In order to retrieve images you captured on the Imaging Device, you need to first create and then retrieve an export.
Generate an export
Use the POST /v2/exports endpoint to generate a media export. You need to:
provide "media" as the export_type
give the export a name
provide the job id you want to download media for
provide the perspective of the media, which can be "tray", "plate" or "well"
and finally specify the format. This can be an image or a timelapse, the size can be original or resized and the range can be all_timepoints or endpoint.
[Optional] Get a list of generated exports
Use the GET /v2/exports endpoint to get a list of all past and ongoing exports or go directly to the endpoint to retrieve a specific export if you already have the export id from the previous step.
Retrieve your export
Use the GET /v2/exports/{exportId} endpoint to retrieve a specific export. If you have just generated the export, you'll need to poll for the export to be ready.
Important note: the download URL will only be valid for a limited time (7 days).