ML Prep API (v1)
Download OpenAPI description
Languages
Servers
Mock server
http://{{your_prep_ip_address}}/
- Mock server
http://{{your_prep_ip_address}}/api/v1/protocol-verification/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'http://{{your_prep_ip_address}}/api/v1/protocol-verification/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The protocol verification data
The database id of the labware that is expected to be in the position, will be -1 if isExpectedOccupied is false
The status of the verification, options are Correct, Missing, Incorrect, Occupied, ConfirmationRequired
The predicted labware classification, Possible values are: Empty, Unknown, Plate, SampleTube, TubeRack, Trough, TipRack, Carrier, MicroTubeRack, MicroTube, Container, Magnet, VirtualTubeRack, Assembly, Lid, LidCarrier
Response
application/json
[ { "expectedLabwareId": 0, "isExpectedOccupied": true, "status": "string", "detectedLabwareId": 0, "confidence": 0.1, "isOccupied": true, "positionId": 0, "labwareClassification": "string", "matches": [ … ], "residualTipData": { … } } ]
- Mock server
http://{{your_prep_ip_address}}/api/v1/protocol-verification/detect-tips/{protocolId}/{positionId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'http://{{your_prep_ip_address}}/api/v1/protocol-verification/detect-tips/{protocolId}/{positionId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "useAllAddresses": true, "addresses": [ { … } ] }