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 Schema API

Defines the structure and constraints for a category of MatrixPlates in Benchling'sinventory system. A MatrixPlateSchema specifies the grid dimensions (height and width),an optional ContainerSchema for tubes that can be inserted, and custom field definitions.Unlike WellPlateSchema where wells are permanently fixed, MatrixPlateSchema definesplates where containers can be inserted into and removed from positions. Examples includetube racks and sample storage matrices. Each schema is associated with a Registryand given a prefix for generating display IDs.

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

Tagged areas include MatrixPlateSchema. 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 89 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 89 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 Matrix Plate Schema 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.

MatrixPlateSchema 9

Defines the structure and constraints for a category of MatrixPlates in Benchling's inventory system. A MatrixPlateSchema specifies the grid dimensions (height and width), an opti…

POST
/matrix-plate-schema
Create MatrixPlateSchema
MatrixPlateSchema.Create 1 param body → 201400403404429500
GET
/matrix-plate-schema/items
List MatrixPlateSchema items
MatrixPlateSchema.List 19 params → 200400403404429500
GET
/matrix-plate-schema/{matrix_plate_schema_id}
Get MatrixPlateSchema by ID
MatrixPlateSchema.Get 4 params → 200400403404429500
PATCH
/matrix-plate-schema/{matrix_plate_schema_id}
Update MatrixPlateSchema
MatrixPlateSchema.Update 2 params body → 200400403404429500
GET
/matrix-plate-schema/{matrix_plate_schema_id}/field-definitions/items
List SchemaFieldDefinition items
MatrixPlateSchema.fieldDefinitions.List 2 params → 200400403404429500
POST
/matrix-plate-schema:batch-create
Batch create MatrixPlateSchema
MatrixPlateSchema.BatchCreate 1 param body → 201400403404429500
PATCH
/matrix-plate-schema:batch-update
Batch update MatrixPlateSchema
MatrixPlateSchema.BatchUpdate 1 param body → 200400403404429500
POST
/matrix-plate-schema:bulk-create
Bulk create MatrixPlateSchema
MatrixPlateSchema.BulkCreate 1 param body → 202400403404429500
PATCH
/matrix-plate-schema:bulk-update
Bulk update MatrixPlateSchema
MatrixPlateSchema.BulkUpdate 1 param body → 202400403404429500

Schemas 89

The contract defines 89 schemas that model the data the API accepts and returns. The most detailed are FloatFieldDefinition (15 properties), MatrixPlateSchema (15 properties), OligoDuplexLinkFieldDefinition (14 properties), AaSequenceLinkFieldDefinition (14 properties). Each schema is shown below with its type and property counts.

CustomEntitySchemaRef
object
2 properties
CreateDnaSequenceLinkFieldDefinitionInput
object
8 properties 6 required
CreateDateFieldDefinitionInput
object
5 properties 4 required
CreateFloatFieldDefinitionInput
object
9 properties 4 required
CreateDnaOligoLinkFieldDefinitionInput
object
8 properties 6 required
AssayRequestLinkFieldDefinition
object
A schema field definition for linking to assay requests.
12 properties
RunSchemaRef
object
2 properties
CreateBooleanFieldDefinitionInput
object
5 properties 4 required
LongTextFieldDefinition
object
A long text field definition for multi-line text values with no length restrictions.
11 properties
UpdateMatrixPlateSchemaInputWithPathParams
object
11 properties 1 required
ResultSchemaRef
object
2 properties
MatrixPlateSchemaPaginatedList
object
2 properties
CustomEntityLinkFieldDefinition
object
A schema field definition for linking to custom entities.
14 properties
TranslationLinkFieldDefinition
object
A schema field definition for linking to translations (AA sequences created from RNA).
13 properties
MixtureLinkFieldDefinition
object
A schema field definition for linking to mixtures.
14 properties
DropdownRef
object
2 properties
CreateRnaSequenceLinkFieldDefinitionInput
object
8 properties 6 required
BaseFieldDefinition
object
A basic schema field definition for primitive data types. Used for fields with types like TEXT, INTEGER, FLOAT, BOOLEAN, DATE, DATETIME, JSON, and LONGTEXT. Ea…
11 properties
CreateCustomEntityLinkFieldDefinitionInput
object
8 properties 6 required
CreateIntegerFieldDefinitionInput
object
8 properties 4 required
DnaOligoSchemaRef
object
2 properties
OligoDuplexLinkFieldDefinition
object
A schema field definition for linking to Oligo Duplexes.
14 properties
DropdownLinkFieldDefinition
object
A schema field definition that links to a dropdown for value selection. The linkDefinition field references the Dropdown configuration that defines the availab…
13 properties
EntryLinkFieldDefinition
object
A schema field definition for linking to notebook entries.
12 properties
CreateTextFieldDefinitionInput
object
5 properties 4 required
SchemaLinkFieldDefinition
object
A schema field definition for link types that reference other Benchling objects. Extends basic field properties with link-specific constraints.
12 properties
InternalServerError
object
6 properties 5 required
RnaOligoLinkFieldDefinition
object
A schema field definition for linking to RNA Oligos.
14 properties
AaSequenceSchemaRef
object
2 properties
StorableLinkFieldDefinition
object
A schema field definition for linking to storable inventory items.
12 properties
RnaSequenceLinkFieldDefinition
object
A schema field definition for linking to RNA sequences.
14 properties
CreateEntryLinkFieldDefinitionInput
object
6 properties 5 required
FloatFieldDefinition
object
A float field definition for decimal number values. Supports numeric constraints (min/max), display precision, and units.
15 properties
ContainerSchemaRef
object
2 properties
CreateBlobLinkFieldDefinitionInput
object
6 properties 5 required
DnaSequenceLinkFieldDefinition
object
A schema field definition for linking to DNA sequences.
14 properties
FieldsetRef
object
2 properties
RegistryRef
object
2 properties
CreateAntibodyLinkFieldDefinitionInput
object
8 properties 6 required
SystemCategoryLinkFieldDefinition
object
A schema field definition for linking to entities that implement a system category (static schema interface).
12 properties
MoleculeLinkFieldDefinition
object
A schema field definition for linking to molecules.
14 properties
FieldsetLinkFieldDefinition
object
A schema field definition for linking to entities that implement a fieldset (custom schema interface).
14 properties
CreateLongTextFieldDefinitionInput
object
5 properties 4 required
CreateMoleculeLinkFieldDefinitionInput
object
8 properties 6 required
CreateAaSequenceLinkFieldDefinitionInput
object
8 properties 6 required
TranscriptionLinkFieldDefinition
object
A schema field definition for linking to transcriptions (RNA sequences created from DNA).
14 properties
CreateAnyEntityLinkFieldDefinitionInput
object
6 properties 5 required
IntegerFieldDefinition
object
An integer field definition for whole number values. Supports numeric constraints (min/max) and units.
14 properties
CreateOligoDuplexLinkFieldDefinitionInput
object
8 properties 6 required
RnaSequenceSchemaRef
object
2 properties
MatrixPlateSchema
object
Defines the structure and constraints for a category of MatrixPlates in Benchling's inventory system. A MatrixPlateSchema specifies the grid dimensions (height…
15 properties
CreateDateTimeFieldDefinitionInput
object
5 properties 4 required
JsonFieldDefinition
object
A JSON field definition for storing structured JSON data.
11 properties
DateFieldDefinition
object
A date field definition for date-only values (without time).
11 properties
OligoDuplexSchemaRef
object
2 properties
RnaOligoSchemaRef
object
2 properties
AnyEntityLinkFieldDefinition
object
A schema field definition for linking to any entity type.
12 properties
CreateMixtureLinkFieldDefinitionInput
object
8 properties 6 required
DnaSequenceSchemaRef
object
2 properties
OligoConjugateLinkFieldDefinition
object
A schema field definition for linking to Oligo Conjugates.
14 properties
BulkImport
object
1 property 1 required
CreateDropdownLinkFieldDefinitionInput
object
7 properties 6 required
DnaPartLinkFieldDefinition
object
A schema field definition for linking to DNA parts.
13 properties
SchemaFieldDefinition
object
BooleanFieldDefinition
object
A boolean field definition for true/false values.
11 properties
MoleculeSchemaRef
object
2 properties
AssayRunLinkFieldDefinition
object
A schema field definition for linking to assay runs.
13 properties
CreateOligoConjugateLinkFieldDefinitionInput
object
8 properties 6 required
CreateRnaOligoLinkFieldDefinitionInput
object
8 properties 6 required
GeneralError
object
5 properties 5 required
EquipmentSchemaRef
object
2 properties
TextFieldDefinition
object
A text field definition for short, single-line text values.
11 properties
EquipmentLinkFieldDefinition
object
A schema field definition for linking to Equipment.
14 properties
DateTimeFieldDefinition
object
A datetime field definition for date and time values with timezone support.
11 properties
AssayResultLinkFieldDefinition
object
A schema field definition for linking to assay results.
13 properties
OligoConjugateSchemaRef
object
2 properties
AaPartLinkFieldDefinition
object
A schema field definition for linking to AA parts.
13 properties
AntibodyLinkFieldDefinition
object
A schema field definition for linking to Antibodies.
13 properties
AsyncTaskLink
object
2 properties
BlobLinkFieldDefinition
object
A schema field definition for linking to blobs (file attachments).
12 properties
CreateMatrixPlateSchemaInput
object
10 properties 5 required
CreateEquipmentLinkFieldDefinitionInput
object
8 properties 6 required
CreateStorableLinkFieldDefinitionInput
object
7 properties 6 required
DnaOligoLinkFieldDefinition
object
A schema field definition for linking to DNA Oligos.
14 properties
SchemaFieldDefinitionUnpaginatedList
object
1 property
UpdateMatrixPlateSchemaInput
object
10 properties
MixtureSchemaRef
object
2 properties
UnitRef
object
2 properties
AaSequenceLinkFieldDefinition
object
A schema field definition for linking to AA sequences.
14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchling-matrixplateschema-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 Schema 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.