How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Benchling Well Plate API

A WellPlate is a multi-well plate in Benchling's inventory system where wells arepermanently fixed to the plate structure. This is the standard plate type for laboratorymulti-well formats such as 96-well, 384-well, and 1536-well plates used in high-throughputscreening, PCR, and other assay workflows. The plate's grid dimensions are defined by itsWellPlateSchema, and each well (see WellPlatePosition) can contain samples, track quantities,and be assigned experimental roles. WellPlates can be stored in Locations (via parentStorage),associated with Studies, and identified by barcode. The plateRecords field tracks the historyof transfers and annotations performed on the plate (see PlateRecord). Unlike MatrixPlatewhere containers can be inserted or removed, WellPlate wells are integral to the plate.

Benchling Well Plate API is one of 203 APIs that Benchling publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include WellPlate. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, rate-limit docs, and a changelog.

This API exposes 9 operations across 8 paths, and defines 40 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, /api/v3.

9 operations 8 paths 40 schemas 3 GET3 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://{tenant}.benchling.com/api/v2
Authentication
HTTP Basic, HTTP Basic, OAuth 2.0
License
Resource Areas
1

Authentication & Security 3

Benchling Well Plate API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basicApiKeyAuth). It accepts HTTP basic authentication (basicClientIdSecretAuth). It supports OAuth 2.0 (oAuth) using the clientCredentials flow. By default, every request must be authenticated.

  • basicApiKeyAuth — Use issued API key for standard access to the API
  • basicClientIdSecretAuth — Auth used as part of client credentials OAuth flow prior to receiving a bearer token.
  • oAuth — OAuth2 Client Credentials flow intended for service access

Paths & Operations 9

Across 8 paths, the API surfaces 9 operations — 3 GET, 3 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

WellPlate 9

A WellPlate is a multi-well plate in Benchling's inventory system where wells are permanently fixed to the plate structure. This is the standard plate type for laboratory multi-we…

POST
/well-plate
Create WellPlate
WellPlate.Create 1 param body → 201400403404429500
GET
/well-plate/items
List WellPlate items
WellPlate.List 22 params → 200400403404429500
GET
/well-plate/{well_plate_id}
Get WellPlate by ID
WellPlate.Get 4 params → 200400403404429500
PATCH
/well-plate/{well_plate_id}
Update WellPlate
WellPlate.Update 2 params body → 200400403404429500
GET
/well-plate/{well_plate_id}/positions/items
List WellPlatePosition items
WellPlate.positions.List 2 params → 200400403404429500
POST
/well-plate:batch-create
Batch create WellPlate
WellPlate.BatchCreate 1 param body → 201400403404429500
PATCH
/well-plate:batch-update
Batch update WellPlate
WellPlate.BatchUpdate 1 param body → 200400403404429500
POST
/well-plate:bulk-create
Bulk create WellPlate
WellPlate.BulkCreate 1 param body → 202400403404429500
PATCH
/well-plate:bulk-update
Bulk update WellPlate
WellPlate.BulkUpdate 1 param body → 202400403404429500

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are IWellPlate (11 properties), WellPlatePosition (11 properties), UpdateWellPlateInputWithPathParams (8 properties), UpdateWellPlateInput (7 properties). Each schema is shown below with its type and property counts.

UpdateWellPlateInput
object
7 properties
FieldValueInput
object
1 property 1 required
UpdateWellPlateInputWithPathParams
object
8 properties 1 required
AnyType
GridCoordinates
object
Read model representing a fillable position in a box or plate.
5 properties
WellPlate
WellPlateSchemaRef
object
2 properties
DateValue
object
A type that represents date values.
2 properties
BooleanValue
object
A type that represents boolean values.
2 properties
ProjectRef
object
2 properties
ObjectLinkValue
object
A type that represents links to other objects.
2 properties
WellPlatePositionUnpaginatedList
object
1 property
WellPlatePosition
object
Represents a single well within a WellPlate, functioning as a fixed container at a specific grid position. Each WellPlatePosition has coordinates identifying i…
11 properties
CreateWellPlateInput
object
6 properties 1 required
ExperimentalRole
object
Represents the complete experimental designation of a well or container within an assay, combining a primary role (see PrimaryExperimentalRole), replicate grou…
4 properties
SchemaFieldValue
object
Represents a field value on a schematized object, pairing a fieldDefinition (describing the field's type and constraints) with its actual value (a BenchlingVal…
5 properties
InternalServerError
object
6 properties 5 required
DecimalValue
object
A type that represents decimal value as strings.
3 properties
AsyncTaskLink
object
2 properties
ArrayValue
object
A type that represents a list of BenchlingValues, used for multi-value cells (e.g. alias columns).
2 properties
ContainerContent
object
Represents a biological or chemical entity stored within a Container or well. Each ContainerContent links an Entity (such as a DNA sequence, protein, or custom…
5 properties
Measurement
object
Represents a quantity with an associated unit of measurement within Benchling's inventory system. Measurements are used throughout inventory to track container…
3 properties
LocationRef
object
2 properties
BulkImport
object
1 property 1 required
ExpirationInfo
object
Provides expiration tracking for inventory items such as containers and their contents. The expirationDate may be explicitly set on the container or inherited…
3 properties
IWellPlate
object
11 properties
PrincipalRef
object
2 properties
DateTimeValue
object
A type that represents datetime values.
2 properties
ContainerSchemaRef
object
2 properties
ObjectRef
object
2 properties
TextValue
object
A type that represents text (string) values.
2 properties
JsonValue
object
A type that represents JSON values.
2 properties
TextAndUrlValue
object
A type that represents text (string) values with an associated URL.
3 properties
IntegerValue
object
A type that represents integer values.
2 properties
SchemaFieldDefinitionRef
object
2 properties
ObjectLinkListValue
object
A type that represents a list of links to other objects.
2 properties
GeneralError
object
5 properties 5 required
UnitRef
object
2 properties
EntityRef
object
2 properties
WellPlatePaginatedList
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchling-wellplate-api-openapi.yml Raw ↑

Other APIs Benchling publishes across the network.

Benchling AA Sequences API
Benchling Apps API
Benchling Assay Results API
Benchling Assay Runs API
Benchling Audit API
Benchling Authentication API
Benchling Blobs API
Benchling Boxes API
Benchling Codon Usage Tables API
Benchling Connect API
Benchling Containers API
Benchling Custom Entities API
Where this information came from

This is an independent, third-party profile of Benchling Well Plate API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.