Recipes

Hands-on examples for common Benchling developer workflows.

These recipes collect task-oriented examples for common Benchling developer workflows across the API, apps, webhooks, Benchling Connect, and R-based analysis. Python examples use the V3 Python SDK against the V3 API, including beta endpoints, so set early_access="true" on the client as each recipe shows. A few recipes still call V2 for steps that V3 doesn’t cover yet, and say so where they do.

Upload results with the API

Create results one at a time, in an all-or-nothing batch, or in bulk.

Register entities

Move entities into the Registry with create, update, or bulk registration flows.

Upload an attachment

Upload a file as an attachment, then link it to a field or a notebook entry.

Create notebook entries with results

Build notebook entries that capture and organize uploaded results.

Get project collaborators

Read project membership and the permissions behind it.

Manage users via the API

Create, update, and suspend Benchling users programmatically.

Push request notifications to Slack

Outdated: a V2 EventBridge integration that notifies Slack from Benchling requests.

Introduction to transfers

Move volume and mass between containers in Benchling Inventory.

Process output files with Benchling Connect

Send instrument output through Benchling Connect and process it programmatically.

Custom transforms in Benchling Connect

Reshape instrument output before it is processed into results.

Work with the API using R

Retrieve, create, update, and archive Benchling data from R.

Work with datasets using R

Pull an analysis data frame into R, fit IC50 curves, and upload the plots back to Benchling.

Step-by-step walkthroughs

These recipes pair a code panel with prose steps that highlight the lines each step is about.

Image file upload

Read an image out of a spreadsheet cell and upload it as an attachment.

Large attachment upload

Stream a large file to Benchling in one request, with the V2 multipart flow as a fallback.

Single transfer: source container

Move a container’s entire contents into an empty destination.

Single transfer: unlimited source

Transfer an entity into a container without drawing down a source container.

Single transfer: non-empty container

Transfer into a container that already has contents, then read back the combined contents.

Bulk transfer: create and fill

Create a plate and fill every well in one bulk call, then poll the async task.

Find users with the V3 SDK

Resolve a user from a username, a display name, or an API ID.

Create a dropdown field

Build dropdown options and create the dropdown in your registry.

Find a box by name and update its parent storage to move it.

Convert SDK objects to JSON

Page through results and serialize the returned SDK models to a file.

Get many entities by name

Chunk a long name list so no request exceeds URL length limits.