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 Matrix Plate API

A MatrixPlate is a rack-style storage plate where Containers (tubes, vials) can beinserted into and removed from grid positions. Unlike FixedPlate or WellPlate wherewells are permanently attached, MatrixPlate positions (see MatrixPlatePosition) canbe empty or hold movable containers. This makes MatrixPlates ideal for tube racks,sample storage boxes with removable tubes, and other flexible storage formats. Eachplate tracks its capacity (totalCapacity, availableCapacity, occupiedCapacity) andconforms to a MatrixPlateSchema that defines the grid dimensions and optionallyrestricts which ContainerSchema types can be stored. MatrixPlates can be stored inLocations, associated with Studies, and identified by barcode.

Benchling Matrix 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 MatrixPlate. 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 8 operations across 7 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

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

8 operations 7 paths 34 schemas 2 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 Matrix 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 8

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

MatrixPlate 8

A MatrixPlate is a rack-style storage plate where Containers (tubes, vials) can be inserted into and removed from grid positions. Unlike FixedPlate or WellPlate where wells are pe…

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

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are IMatrixPlate (15 properties), CreateMatrixPlateInput (8 properties), UpdateMatrixPlateInputWithPathParams (8 properties), UpdateMatrixPlateInput (7 properties). Each schema is shown below with its type and property counts.

MatrixPlate
CreateMatrixPlateInput
object
8 properties 1 required
FieldValueInput
object
1 property 1 required
AnyType
MatrixPlatePaginatedList
object
2 properties
GridCoordinates
object
Read model representing a fillable position in a box or plate.
5 properties
DateValue
object
A type that represents date values.
2 properties
MatrixPlatePosition
object
A well position within a MatrixPlate.
3 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
UpdateMatrixPlateInput
object
7 properties
UpdateMatrixPlateInputWithPathParams
object
8 properties 1 required
InternalServerError
object
6 properties 5 required
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
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
MatrixPlateSchemaRef
object
2 properties
MatrixPlatePositionInput
object
2 properties 1 required
LocationRef
object
2 properties
BulkImport
object
1 property 1 required
PrincipalRef
object
2 properties
DateTimeValue
object
A type that represents datetime values.
2 properties
ObjectRef
object
2 properties
ContainerRef
object
2 properties
IMatrixPlate
object
15 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
GeneralError
object
5 properties 5 required
ObjectLinkListValue
object
A type that represents a list of links to other objects.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchling-matrixplate-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 Matrix 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.