{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/prep/sidebars.yaml","oas-products/prep/api/openapi.yaml":"oas-products/prep/api/openapi.yaml"},"props":{"metadata":{"markdoc":{"tagList":["img","split","openapi-code-sample"]},"type":"markdown"},"seo":{"title":"Create a Prep protocol","description":"Hamilton's Developer Portal is used to help reference and understand the APIs of Hamilton products.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"create-a-prep-protocol"},"children":["Create a Prep protocol"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"id":"51559572107","level":2},"children":["Get labware information "]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The labware used in a protocol is obtained using the ",{"$$mdtype":"Tag","name":"span","attributes":{"className":"code"},"children":["Get"]}," method and the labware ",{"$$mdtype":"Tag","name":"span","attributes":{"className":"item"},"children":["{name}"]},". The deck information, consisting of the labware information and what positions they occupy on the deck, are passed in the time of creating the protocol. The ",{"$$mdtype":"Tag","name":"span","attributes":{"className":"item"},"children":["{name}"]}," is displayed in the Labware's Details info card."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/labware-name.2e78826ace7dd443ece5e546d440208d1d523272ee8128400e1cc2316cb9e5a5.86b22610.png","alt":"labware-name","withLightbox":false,"width":"40%"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"id":"51559573259","level":2},"children":["Get the tips to be used in the protocol "]},{"$$mdtype":"Tag","name":"Split","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Labware"]},": 300 µL tip rack (Nested Conductive No Filter)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Name"]},": 235950"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-products/prep/api/openapi.yaml","operationId":"GetLabwareByName","parameters":{},"environments":{}},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"id":"51559574411","level":2},"children":["Get the plate to be used in the protocol "]},{"$$mdtype":"Tag","name":"Split","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This uses the same call as in ",{"$$mdtype":"Tag","name":"a","attributes":{"className":"schema-iframe-link","href":"prep_recipe_protocol_create#51559573259"},"children":["Get the tips to be used in the protocol"]},", but with different labware:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Labware"]},": Hamilton, Deep Well, U-Bottom, 2.2mL, Clear"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Name"]},": DW96w2200jjxsqHAM"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-products/prep/api/openapi.yaml","operationId":"GetLabwareByName","parameters":{},"environments":{}},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"id":"51559575563","level":2},"children":["Create new protocol and pass deck info "]},{"$$mdtype":"Tag","name":"Split","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Pass everything the protocol needs here."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-products/prep/api/openapi.yaml","operationId":"AddProtocol","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"api-call-body-example"},"children":["API call body example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{ \n  \"id\": 0, \n  \"name\": \"create protocol\",\n   \"makeNameUnique\": true, \n  \"skipValidation\": true, \n  \"createdByUserName\": \"adminsys\", \n  \"deck\": {\n     \"positions\": [       { \n        \"id\": 0, \n        \"position\": 1,\n         \"positionName\": \"\", \n        \"liquidVolume\": 0 \n      }, \n      {\n         \"id\": 0, \n        \"position\": 2, \n        \"positionName\": \"Tip Rack\",\n         \"liquidVolume\": 0, \n        \"labwareGroupId\": 0, \n        \"labwareGroup\": {\n           \"groupName\": \"235950\", \n          \"labwareId\": \"{{tipId}}\",\n           \"liquidName\": \"\", \n          \"liquidType\": \"\",\n           \"reuseTipsBetweenSteps\": false \n        }       }, \n      {\n         \"id\": 0, \n        \"position\": 3, \n        \"positionName\": \"\",\n         \"liquidVolume\": 0 \n      }, \n      { \n        \"id\": 0,\n         \"position\": 4, \n        \"positionName\": \"\", \n        \"liquidVolume\": 0 \n      },\n       {         \"id\": 0, \n        \"position\": 5, \n        \"positionName\": \"\",\n         \"liquidVolume\": 0 \n      }, \n      {         \"id\": 0,\n         \"position\": 6, \n        \"positionName\": \"Plate\", \n        \"labwareGroupId\": 0,\n         \"liquidVolume\": 0, \n        \"labwareGroup\": { \n          \"id\": 0,\n           \"groupName\": \"DW96w2200jjxsqHAM\", \n          \"labwareId\": \"{{hamiltonPlate}}\",\n           \"liquidVolume\": \"\", \n          \"liquidType\": \"\",\n           \"reuseTipsBetweenSteps\": false \n        }       }, \n      {\n         \"id\": 0, \n        \"position\": 7, \n        \"positionName\": \"\",\n         \"liquidVolume\": 0 \n      }, \n      {         \"id\": 0,\n         \"position\": 8, \n        \"positionName\": \"\", \n        \"liquidVolume\": 0 \n      }\n     ] \n  } }\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"id":"51559576715","level":2},"children":["Add step to the protocol "]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Go to ",{"$$mdtype":"Tag","name":"a","attributes":{"className":"schema-iframe-link","href":"prep_recipe_protocol_add_ts_step"},"children":["Add a Transfer Samples step to an existing protocol"]}," to add a step to the newly created protocol."]}]},"headings":[{"value":"Create a Prep protocol","id":"create-a-prep-protocol","depth":1},{"value":"Get labware information","id":"51559572107","depth":2},{"value":"Get the tips to be used in the protocol","id":"51559573259","depth":2},{"value":"Get the plate to be used in the protocol","id":"51559574411","depth":2},{"value":"Create new protocol and pass deck info","id":"51559575563","depth":2},{"value":"API call body example","id":"api-call-body-example","depth":3},{"value":"Add step to the protocol","id":"51559576715","depth":2}],"frontmatter":{"seo":{"title":"Create a Prep protocol"}},"lastModified":"2026-07-30T19:22:04.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/pages/prep_recipe_protocol_create","userData":{"isAuthenticated":false,"teams":["anonymous"]}}