Benchling
Guides
API Reference
{{user.name}}
Log In
The Benchling API
Welcome to the Benchling API.
Search results for "
{{ search.query }}
"
No results found for "{{search.query}}".
Documentation {{result.projectName ? 'in ' + result.projectName : ''}}
{{result._method}}
Reference {{result.projectName ? 'in ' + result.projectName : ''}}
Changelog {{result.projectName ? 'in ' + result.projectName : ''}}
Discussions {{result.projectName ? 'in ' + result.projectName : ''}}
Page {{result.projectName ? 'in ' + result.projectName : ''}}
View All Results
v2
v1
deprecated
beta
v2-beta
beta
v2
stable
Home
Guides
API Reference
Reference
Changelog
Discussions
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
Home
Guides
API Reference
discard
Save Edits
Submit
Suggested Edits
Search results for "
{{ search.query }}
"
No results found for "{{search.query}}".
Documentation {{result.projectName ? 'in ' + result.projectName : ''}}
{{result._method}}
Reference {{result.projectName ? 'in ' + result.projectName : ''}}
Changelog {{result.projectName ? 'in ' + result.projectName : ''}}
Discussions {{result.projectName ? 'in ' + result.projectName : ''}}
Page {{result.projectName ? 'in ' + result.projectName : ''}}
View All Results
General
Developer Platform Overview
API
Tutorial
Authentication
Errors
Pagination
Rate Limiting
Example: Uploading Instrument Results
Warehouse
Overview
Getting started
Warehouse Tables
Permissions and Security
Support
Core Resources
DNA Sequences
DNA Sequence Resource
get
List DNA sequences
get
Get a DNA sequence
get
BulkGet DNA sequences
post
Create a DNA sequence
post
Bulk create DNA sequences
patch
Update a DNA sequence
post
Autofill DNA sequence parts
post
Archive DNA sequences
post
Unarchive DNA sequences
Oligos
Oligo Resource
get
Get an oligo
post
Create an oligo
post
Bulk create oligos
AA Sequences
AA Sequence Resource
get
List AA sequences
get
Get an AA sequence
get
BulkGet AA sequences
post
Create an AA sequence
post
Bulk create AA sequences
patch
Update an AA sequence
post
Archive AA sequences
post
Unarchive AA sequences
Custom Entities
Custom Entity Resource
get
List custom entities
get
Get a custom entity
get
BulkGet custom entities
post
Create a custom entity
post
Bulk create custom entities
patch
Update custom entity
post
Bulk update custom entities
post
Archive custom entities
post
Unarchive custom entities
Registry
Registry Resource
get
List registries
get
BulkGet registered entities
Registration
post
Bulk register entities
post
Unregister entities
Batches
Batch Resource
get
List batches
get
Get a batch
get
Get an entity's batches
get
BulkGet batches
post
Create a batch
patch
Update a batch
post
Archive batches
post
Unarchive batches
Molecular Biology
DNA Alignments
DNA Alignment Resource
get
Get a DNA alignment
post
Create a template DNA alignment
post
Create a consensus DNA alignment
delete
Delete DNA alignment
Storage
Containers
Container Resource
get
List containers
get
Get a container
get
BulkGet containers
post
Create a container
patch
Update a container
post
Print labels
post
Archive containers
post
Unarchive containers
Plates
Plate Resource
get
List plates
get
Get a plate
get
BulkGet plates
post
Create a plate
patch
Update a plate
post
Archive plates
post
Unarchive plates
Boxes
Box Resource
get
List boxes
get
Get a box
get
BulkGet boxes
post
Create a box
post
Archive boxes
post
Unarchive boxes
patch
Update a box
Locations
Location Resource
get
List locations
get
Get a location
get
BulkGet locations
post
Create a location
patch
Update a location
post
Archive locations
post
Unarchive locations
Transfers
post
Transfer into container
post
Transfer into multiple containers
Label Templates
Label Template Resource
get
List label templates
Printers
Printer Resource
get
List printers
get
Validate barcodes
Notebook
Entries
Entry Resource
Note Resource
Link Resource
ExternalFile Resource
get
List entries
get
Get an entry
get
BulkGet entries
get
Get an external file
post
Create an entry
patch
Update entry metadata
post
Archive entries
post
Unarchive entries
Results
Results
Result Resource
post
Create results
get
List results
get
BulkGet results
post
Create a transaction to upload results
post
Create results in a transaction
post
Commit a transaction
post
Abort a transaction
Runs
Run Resource
post
Create runs
get
List runs
get
BulkGet runs
User Validation Resource
Blobs
Blob Resource
get
BulkGet blobs
get
Get a blob's download URL
post
Upload single-part blob
post
Start multi-part blob upload
post
Upload blob part
post
Complete blob upload
post
Abort a blob upload
Requests
Requests
Request Resource
Request Assignee Resource
Request Sample Resource
Request Sample Group Resource
RequestResponse Resource
get
List requests
get
Get a request
get
BulkGet requests
get
Get a request's response
post
Create request
patch
Update a request
post
Execute sample groups
Workflows
Workflows
Workflow Resource
get
List workflows
patch
Update workflow metadata
Stages
WorkflowStage Resource
get
List workflow stages
Stage Runs
StageRun Resource
get
List workflow stage runs
Samples
Sample Resource
get
List stage run input samples
get
List stage run output samples
get
List stage run registered samples
Schemas
Fields Resource
Dropdowns
Dropdown Resource
get
List dropdowns
get
Get dropdown
post
Create dropdown
patch
Update dropdown options
Entity Schemas
EntitySchema Resource
get
List entity schemas
Batch Schemas
BatchSchema Resource
get
List batch schemas
Container Schemas
ContainerSchema Resource
get
List container schemas
Plate Schemas
PlateSchema Resource
get
List plate schemas
Box Schemas
BoxSchema Resource
get
List box schemas
Location Schemas
LocationSchema Resource
get
List location schemas
Result Schemas
ResultSchema Resource
get
Get a result schema
get
List result, run, and request schemas
Run Schemas
RunSchema Resource
get
Get a run schema
Request Schemas
RequestSchema Resource
get
Get a request schema
Projects and Users
Projects
Project Resource
get
List projects
post
Archive projects
post
Unarchive projects
Folders
Folder Resource
get
Get a folder
get
List folders
post
Archive folders
post
Unarchive folders
OrganizationSummary Resource
TeamSummary Resource
UserSummary Resource
Other
ArchiveRecord Resource
Tasks
Task Resource
get
Get a task
Warehouse
post
Create warehouse credentials
Exports
post
Export item
General
Developer Platform Overview
API
Tutorial
Authentication
Errors
View All 6
Warehouse
Overview
Getting started
Warehouse Tables
View All 4
Core Resources
DNA Sequences
Oligos
AA Sequences
View All 4
Registry
Registry Resource
get
List registries
get
BulkGet registered entities
View All 5
Molecular Biology
DNA Alignments
Storage
Containers
Plates
Boxes
View All 8
Notebook
Entries
Results
Results
Runs
User Validation Resource
View All 4
Requests
Requests
Workflows
Workflows
Stages
Stage Runs
View All 4
Schemas
Fields Resource
Dropdowns
Entity Schemas
View All 11
Projects and Users
Projects
Folders
OrganizationSummary Resource
View All 5
Other
ArchiveRecord Resource
Tasks
Warehouse
post
Create warehouse credentials
Exports
post
Export item