Skip to navigation
Benchling APIPlate Record

Transfer PlateRecords asynchronously

Asynchronously create destination plate record(s) by transferring content out of existing source plates, alongside a copy of each source holding what remained.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
heightintegerRequired
Number of rows in each destination plate record.
namestringRequired

Base name for destination plate record(s). If multiple are created, numeric suffixes are appended.

transferobjectRequired

Transfer specification describing explicit operations or a layout-derived transfer.

widthintegerRequired
Number of columns in each destination plate record.
destinationBarcodeslist of stringsOptional

Optional barcode to stamp on each destination plate record, one entry per destination plate in destination-index order. Length must equal the number of destination plates.

metadataLayerslist of objectsOptional
Metadata layers to apply to each created destination plate record.
plateSchemaIdstringOptional
ID of the plate schema to apply to each destination plate record. If omitted, no plate schema is attached.

Response

Task started
pollingUristringOptionalformat: "uri"
taskIdstringOptional

Errors

400
Plate Record Transfer Async Request Bad Request Error
403
Plate Record Transfer Async Request Forbidden Error
404
Plate Record Transfer Async Request Not Found Error
409
Plate Record Transfer Async Request Conflict Error
429
Plate Record Transfer Async Request Too Many Requests Error
500
Plate Record Transfer Async Request Internal Server Error