> This page is for Developer Documentation.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.benchling.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.benchling.com/_mcp/server.

# Transfer PlateRecords asynchronously

POST https://{tenant_name}.benchling.com/api/v3/plate-record:transfer-async
Content-Type: application/json

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

Reference: https://docs.benchling.com/docs/api/benchling-api/plate-record/transferasync

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Body (application/json)

This endpoint expects a PlateRecordTransferRequestInput.

- `height` (integer, required) — Number of rows in each destination plate record.
- `name` (string, required) — Base name for destination plate record(s). If multiple are created, numeric suffixes are appended.
- `transfer` (PlateRecordTransferInput, required) — Transfer specification describing explicit operations or a layout-derived transfer.
- `width` (integer, required) — Number of columns in each destination plate record.
- `destinationBarcodes` (list of string, optional) — 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.
- `metadataLayers` (list of MetadataColumnInput, optional) — Metadata layers to apply to each created destination plate record.
- `plateSchemaId` (string, optional) — ID of the plate schema to apply to each destination plate record. If omitted, no plate schema is attached.

## Response

### 202

Task started

- `pollingUri` (string, optional)
- `taskId` (string, optional)

## Errors

### 400 Plate Record Transfer Async Request Bad Request Error

Bad Request

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 403 Plate Record Transfer Async Request Forbidden Error

Forbidden

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 404 Plate Record Transfer Async Request Not Found Error

Not Found

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 409 Plate Record Transfer Async Request Conflict Error

Conflict

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 429 Plate Record Transfer Async Request Too Many Requests Error

Too Many Requests

- `detail` (TooManyRequestsErrorBodyDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)
- `violated-policies` (list of enum, optional) — The budget policies that rejected the request, in canonical order: `user`, `integration`, then `tenant`.
  - Allowed values: `user`, `integration`, `tenant`

### 500 Plate Record Transfer Async Request Internal Server Error

Internal Server Error

- `detail` (InternalServerErrorBodyDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `errorId` (string, optional)

## Types

### PlateRecordTransferInput

- `direction` (enum, optional) — Well traversal order for layout-based transfers. Defaults to ACROSS_ROWS.
  - Allowed values: `ACROSS_ROWS`, `DOWN_COLUMNS`
- `layout` (enum, optional) — Layout algorithm used with sourcePlateIds. Determines the fan ratio of sources to destinations: STAMP (1:1), STAMP_TO_QUADRANTS/INTERLEAVE (4:1), COLUMN_INTERLEAVE (2:1), and their REVERSE_ variants (1:4, 1:2).
  - Allowed values: `COLUMN_INTERLEAVE`, `INTERLEAVE`, `REVERSE_COLUMN_INTERLEAVE`, `REVERSE_INTERLEAVE`, `REVERSE_STAMP_TO_QUADRANTS`, `STAMP`, `STAMP_TO_QUADRANTS`
- `operations` (list of WellTransferInput, optional) — Explicit well-to-well moves. Use this mode for fan-in, many-to-many, or serial dilution transfers. Mutually exclusive with sourcePlateIds + layout.
- `skipEmpty` (boolean, optional) — If true (default), empty source wells are skipped rather than producing empty destination wells in layout-based transfers.
- `sourcePlateIds` (list of string, optional) — Ordered source plates for layout-based transfers. Consumed group by group according to the fan ratio of the chosen layout. Mutually exclusive with operations.
- `transferQuantity` (QuantityInput, optional) — Volume to transfer per well in layout-based transfers. If omitted, the entire source well content is recorded as transferred.

### MetadataColumnInput

- `name` (string, required)
- `type` (enum, required)
  - Allowed values: `text`, `integer`, `float`, `boolean`, `date`, `datetime`
- `plateValue` (MetadataColumnInputPlateValue, optional, nullable)
- `systemName` (string, optional)
- `wells` (list of MetadataWellInput, optional)

### GeneralErrorDetail

### TooManyRequestsErrorBodyDetail

### InternalServerErrorBodyDetail

### WellTransferInput

- `destinationPlateIndex` (integer, required)
- `destinationWellPosition` (string, required)
- `sourceWellPosition` (string, required)
- `diluentEntityId` (string, optional)
- `diluentQuantity` (QuantityInput, optional)
- `finalVolume` (QuantityInput, optional)
- `sourceDestinationPlateIndex` (integer, optional)
- `sourcePlateId` (string, optional)
- `transferQuantity` (QuantityInput, optional)

### QuantityInput

- `amount` (double, required)
- `unit` (UnitInputWithPathParams, optional)

### MetadataColumnInputPlateValue

### MetadataWellInput

- `value` (MetadataWellInputValue, required, nullable)
- `wellPosition` (string, required)

### UnitInputWithPathParams

- `id` (string, required)
- `versionNumber` (integer, optional)

### MetadataWellInputValue

## Examples

**Request**

```json
{
  "height": 1,
  "name": "name",
  "width": 1
}
```

**Response**

```json
{
  "pollingUri": "pollingUri",
  "taskId": "taskId"
}
```

**SDK Code**

```python
import requests

url = "https://{tenant_name}.benchling.com/api/v3/plate-record:transfer-async"

payload = {
    "height": 1,
    "name": "name",
    "width": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://{tenant_name}.benchling.com/api/v3/plate-record:transfer-async';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"height":1,"name":"name","width":1}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```