Skip to content
DEVELOPER FORUM
Search
API
/
ML Prep API
ML Prep API
(v1)
Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
http://{{your_prep_ip_address}}/
Authenticate
Operations
post
/api/v1/authenticate/setup-wizard
post
/api/v1/authenticate/kba-password-reset
get
/api/v1/authenticate/check-authentication
post
/api/v1/authenticate
delete
/api/v1/authenticate
post
/api/v1/authenticate/renew-token
post
/api/v1/authenticate/change-expired-password
+ Show
Backups
Operations
get
/api/v1/backups
get
/api/v1/backups/export
post
/api/v1/backups/batch-delete
+ Show
Calibration
Operations
get
/api/v1/calibration/channel-results
post
/api/v1/calibration/channel-results
get
/api/v1/calibration/export
get
/api/v1/calibration/images/{imageName}
post
/api/v1/calibration/self-calibration
post
/api/v1/calibration/channel-height-squeeze
post
/api/v1/calibration/hepa-filter-calibration
post
/api/v1/calibration/abort
Show 6 more...
+ Show
Camera
Operations
get
/api/v1/camera/{rectify}
get
/api/v1/camera/calibration-pattern
get
/api/v1/camera/parameters
get
/api/v1/camera/position/{positionId}/{padding}/{zHeight}
get
/api/v1/camera/position/tip-rack/{positionId}/{zHeight}/{color}
get
/api/v1/camera/get-frame
get
/api/v1/camera/get-weighted-frame
get
/api/v1/camera/vision-system-status
Show 9 more...
+ Show
Configuration
Operations
post
/api/v1/configuration/cors
get
/api/v1/configuration/cors
delete
/api/v1/configuration/cors/{originId}
get
/api/v1/configuration/cors/{originId}
+ Show
Credentials
Operations
get
/api/v1/credentials
post
/api/v1/credentials
put
/api/v1/credentials
get
/api/v1/credentials/{id}
delete
/api/v1/credentials/{id}
+ Show
Deck
Operations
put
/api/v1/deck/calibrate
get
/api/v1/deck/calibrate
get
/api/v1/deck/legacy-scan/{numMatches}
get
/api/v1/deck/scan/{numMatches}
put
/api/v1/deck/{protocolId}
get
/api/v1/deck/{deckLayoutId}
+ Show
Diagnostics
Operations
get
/api/v1/diagnostics
get
/api/v1/diagnostics/protocols/{protocolId}
put
/api/v1/diagnostics/protocol/demo
put
/api/v1/diagnostics/instrument/transport
put
/api/v1/diagnostics/instrument/hhs
put
/api/v1/diagnostics/instrument/tip-pickup
put
/api/v1/diagnostics/instrument/drip
put
/api/v1/diagnostics/instrument/pressure
Show 6 more...
+ Show
Enclosure
Operations
post
/api/v1/enclosure
post
/api/v1/enclosure/set-custom-lighting
post
/api/v1/enclosure/set-automatic-lighting
post
/api/v1/enclosure/dismiss-lighting-error
put
/api/v1/enclosure/monitor-fan-state
+ Show
Environment
Operations
get
/api/v1/environment
+ Show
Errors
Operations
get
/api/v1/errors
get
/api/v1/errors/{errorId}
put
/api/v1/errors/runtime
get
/api/v1/errors/check-for-pending-errors
put
/api/v1/errors/clear-errors
+ Show
HepaUv
Operations
put
/api/v1/hepa-uv/start-hepa-fan
put
/api/v1/hepa-uv/stop-hepa-fan
get
/api/v1/hepa-uv/is-hepa-fan-running
get
/api/v1/hepa-uv/pre-filter-usage
get
/api/v1/hepa-uv/hepa-filter-pressure
+ Show
Instruments
Operations
get
/api/v1/instruments/all-available
post
/api/v1/instruments/initialize
get
/api/v1/instruments/global-run-state
get
/api/v1/instruments
put
/api/v1/instruments
get
/api/v1/instruments/get-active-system
get
/api/v1/instruments/connection-status
get
/api/v1/instruments/connection-info
Show 3 more...
+ Show
Labware
Operations
get
/api/v1/labware
get
/api/v1/labware/{id}
delete
/api/v1/labware/{id}
get
/api/v1/labware/properties/classifications
get
/api/v1/labware/by-name/{name}
get
/api/v1/labware/export/{labwareId}
get
/api/v1/labware/export
post
/api/v1/labware/find-existing-imports
Show 5 more...
+ Show
LabwareCategories
Operations
get
/api/v1/labware-categories
get
/api/v1/labware-categories/classifications/{classificationId}
get
/api/v1/labware-categories/groups/{grouping}
get
/api/v1/labware-categories/groups
+ Show
LabwareSignature
Operations
put
/api/v1/labware-signature/update
get
/api/v1/labware-signature/export
put
/api/v1/labware-signature/import
put
/api/v1/labware-signature/create
+ Show
Lighting
Operations
get
/api/v1/lighting/deck-lights-setting-options
get
/api/v1/lighting
put
/api/v1/lighting
+ Show
LiquidClass
Operations
get
/api/v1/liquid-classes
post
/api/v1/liquid-classes
put
/api/v1/liquid-classes
post
/api/v1/liquid-classes/batch-delete
post
/api/v1/liquid-classes/find-usage
get
/api/v1/liquid-classes/settings
put
/api/v1/liquid-classes/import/{ignoreLabwareDefinitionFiles}
post
/api/v1/liquid-classes/find-existing-imports
Show 1 more...
+ Show
Maintenance
Operations
post
/api/v1/maintenance/initialize
get
/api/v1/maintenance
get
/api/v1/maintenance/{id}
post
/api/v1/maintenance/{id}
get
/api/v1/maintenance/images/{imageName}
get
/api/v1/maintenance/errors
get
/api/v1/maintenance/channel-counters
post
/api/v1/maintenance/reset-channel-counters/{channel}
Show 5 more...
+ Show
NetworkConfiguration
Operations
get
/api/v1/network-configuration
put
/api/v1/network-configuration
put
/api/v1/network-configuration/default
get
/api/v1/network-configuration/changes
get
/api/v1/network-configuration/remote-desktop-enabled
put
/api/v1/network-configuration/enable-remote-desktop
put
/api/v1/network-configuration/disable-remote-desktop
+ Show
Power
Operations
put
/api/v1/power/request-powerdown
put
/api/v1/power/confirm-powerdown
put
/api/v1/power/cancel-powerdown
put
/api/v1/power/channel-power/{enabled}
get
/api/v1/power/is-initialized
put
/api/v1/power/servo-power/{enabled}
put
/api/v1/power/monitor-powerdown
+ Show
ProtocolRun
Operations
get
/api/v1/protocol-run
post
/api/v1/protocol-run/create
put
/api/v1/protocol-run/submit-hit-pick-file
put
/api/v1/protocol-run/submit-reagent-from-file-file
put
/api/v1/protocol-run/submit-barcodes
put
/api/v1/protocol-run/submit-normalization-file
post
/api/v1/protocol-run/rtsa
get
/api/v1/protocol-run/simulation-speed
Show 9 more...
+ Show
Protocols
Operations
get
/api/v1/protocols
post
/api/v1/protocols
get
/api/v1/protocols/names
get
/api/v1/protocols/properties/step-types
get
/api/v1/protocols/get-unique-name
get
/api/v1/protocols/verify/{id}
get
/api/v1/protocols/preview/{id}
get
/api/v1/protocols/{id}
Show 12 more...
+ Show
ProtocolSteps
Operations
post
/api/v1/protocols/{protocolId}/step
put
/api/v1/protocols/{protocolId}/step
get
/api/v1/protocols/{protocolId}/step
put
/api/v1/protocols/{protocolId}/step/reorder-step
put
/api/v1/protocols/{protocolId}/step/rename/{stepId}
put
/api/v1/protocols/{protocolId}/step/disable/{stepId}
get
/api/v1/protocols/{protocolId}/step/{stepId}
delete
/api/v1/protocols/{protocolId}/step/{stepId}
+ Show
ProtocolSupport
Operations
get
/api/v1/protocol-support/example-hit-pick-worklist-file
get
/api/v1/protocol-support/example-hit-pick-worklist-data
get
/api/v1/protocol-support/example-reagent-from-file-worklist-file
get
/api/v1/protocol-support/example-reagent-from-file-worklist-data
get
/api/v1/protocol-support/example-normalization-worklist-file
get
/api/v1/protocol-support/example-normalization-worklist-data
+ Show
ProtocolVerification
Operations
get
/api/v1/protocol-verification/{id}
get
/api/v1/protocol-verification/detect-tips/{protocolId}/{positionId}
+ Show
Repair
Operations
post
/api/v1/repair
+ Show
Report
Operations
get
/api/v1/report/pvk/data/{id}
get
/api/v1/report/pvk/file/{verificationRunId}
get
/api/v1/report/pvk/export
get
/api/v1/report/pvk/file/{verificationRunId}/name
+ Show
Roles
Operations
get
/api/v1/roles
get
/api/v1/roles/summaries
get
/api/v1/roles/{id}
+ Show
RunData
Operations
get
/api/v1/run-data
get
/api/v1/run-data/{runDataId}
get
/api/v1/run-data/{runDataId}/pdf
get
/api/v1/run-data/{runDataId}/pipetting-csv
get
/api/v1/run-data/{runDataId}/pipetting-csv/{stepId}
get
/api/v1/run-data/get-run-result-enum
get
/api/v1/run-data/date-range-options
delete
/api/v1/run-data/{runDataIds}
Show 2 more...
+ Show
Screenshots
Operations
get
/api/v1/screenshots/{imageName}
get
/api/v1/screenshots
get
/api/v1/screenshots/export
post
/api/v1/screenshots/batch-delete
+ Show
ServiceSoftwareApi
Operations
post
/api/v1/service-software-api/doorstate
get
/api/v1/service-software-api/doorstate
post
/api/v1/service-software-api/powerdown
get
/api/v1/service-software-api/powerdown
post
/api/v1/service-software-api/fanstate
get
/api/v1/service-software-api/fanstate
get
/api/v1/service-software-api/sensor-status
get
/api/v1/service-software-api/is-parked
Show 1 more...
+ Show
Settings
Operations
get
/api/v1/settings/{categoryId}/{settingId}
put
/api/v1/settings
get
/api/v1/settings/software-settings
post
/api/v1/settings/software-settings
get
/api/v1/settings/policy-settings
post
/api/v1/settings/policy-settings
get
/api/v1/settings/instrument-settings
post
/api/v1/settings/instrument-settings
Show 11 more...
+ Show
SoftwareVersions
Operations
get
/api/v1/software-versions
get
/api/v1/software-versions/instrument
get
/api/v1/software-versions/instinct-api
get
/api/v1/software-versions/service-software
+ Show
SystemReady
Operations
get
/api/v1/system-ready
+ Show
SystemTime
Operations
get
/api/v1/system-time
put
/api/v1/system-time
get
/api/v1/system-time/time-zones
get
/api/v1/system-time/min-system-time
get
/api/v1/system-time/max-system-time
+ Show
ThermalDevice
Operations
get
/api/v1/thermal-device/hhc/configuration
put
/api/v1/thermal-device/hhc/configuration
get
/api/v1/thermal-device/hhc/temperature-status
put
/api/v1/thermal-device/hhc/start-temperature-control
put
/api/v1/thermal-device/hhc/stop-temperature-control
+ Show
Traces
Operations
get
/api/v1/traces
get
/api/v1/traces/export
get
/api/v1/traces/sources
+ Show
UserKba
Operations
post
/api/v1/user-kba
get
/api/v1/user-kba/{userName}
delete
/api/v1/user-kba/{userName}
post
/api/v1/user-kba/validate-kba-answer
+ Show
Users
Operations
get
/api/v1/users
post
/api/v1/users
get
/api/v1/users/{id}
patch
/api/v1/users/{id}
delete
/api/v1/users/{id}
get
/api/v1/users/disable-user-management
post
/api/v1/users/enable-user-management
put
/api/v1/users/set-user-account-policy-defaults
Show 2 more...
+ Show
Verification
Operations
post
/api/v1/verification/authenticate
get
/api/v1/verification/service-routines
put
/api/v1/verification/service-routines
get
/api/v1/verification/service-routines/{id}
put
/api/v1/verification/workflow/service-routine-run/{index}
get
/api/v1/verification/workflow/routine-run/{index}
post
/api/v1/verification/service-routines/{serviceRoutineId}
get
/api/v1/verification/routines
Show 15 more...
+ Show
VerificationResult
Operations
post
/api/v1/verification-result
get
/api/v1/verification-result/get-all-items
get
/api/v1/verification-result/get-item/{itemName}
+ Show