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

A plate design or record used for designing, tracking, and analyzing experimental platesoutside of the inventory.Scratch plates are the working surface for plate-based workflows: you build upa plate's layout (well roles, contents, concentrations, metadata, measurements)through one or more creates and updates, then optionally convert it to apersistent inventory plate via the `bulk-put-in-inventory` endpoint.Each layer of data (label, content, concentration, metadata, measurements, etc.)is accessible via its `dataFrame`.These endpoints are not generally available and may fail depending on your tenant configuration.

Benchling Scratch 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 ScratchPlate. 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 12 operations across 11 paths, and defines 32 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

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

12 operations 11 paths 32 schemas 3 GET3 PATCH6 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 Scratch 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 12

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

ScratchPlate 12

A plate design or record used for designing, tracking, and analyzing experimental plates outside of the inventory. Scratch plates are the working surface for plate-based workflows…

POST
/scratch-plate
Create ScratchPlate
ScratchPlate.Create 1 param body → 201400403404429500
GET
/scratch-plate/items
List ScratchPlate items
ScratchPlate.List 15 params → 200400403404429500
GET
/scratch-plate/{scratch_plate_id}
Get ScratchPlate by ID
ScratchPlate.Get 4 params → 200400403404429500
PATCH
/scratch-plate/{scratch_plate_id}
Update ScratchPlate
ScratchPlate.Update 2 params body → 200400403404429500
POST
/scratch-plate:batch-create
Batch create ScratchPlate
ScratchPlate.BatchCreate 1 param body → 201400403404429500
PATCH
/scratch-plate:batch-update
Batch update ScratchPlate
ScratchPlate.BatchUpdate 1 param body → 200400403404429500
POST
/scratch-plate:bulk-create
Bulk create ScratchPlate
ScratchPlate.BulkCreate 1 param body → 202400403404429500
POST
/scratch-plate:bulk-put-in-inventory
Create a registry plate from each scratch plate, populating wells from the scratch plate's label and content layers and any column mappings. Each item targets a plate schema (explicit or inherited fr…
ScratchPlate.BulkPutInInventory 1 param body → 202400403404429500
PATCH
/scratch-plate:bulk-update
Bulk update ScratchPlate
ScratchPlate.BulkUpdate 1 param body → 202400403404429500
POST
/scratch-plate:transfer
Create destination scratch plate(s) by transferring content out of existing source plates. Each move is recorded as a destinationtransfer on the child and a sourcetransfer on the source. The source p…
ScratchPlate.Transfer 1 param body → 200400403404429500
POST
/scratch-plate:transfer-async
Asynchronously create destination scratch plate(s) by transferring content out of existing source plates, alongside a copy of each source holding what remained.
ScratchPlate.TransferAsync 1 param body → 202400403404429500
GET
/tasks/scratch-plate/transfer-async/{task_id}
Poll async task status
ScratchPlate.TransferAsync.Get 2 params → 200400403404429500

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are CreateScratchPlateInput (14 properties), ContentItemInput (12 properties), WellTransferInput (9 properties), ScratchPlate (9 properties). Each schema is shown below with its type and property counts.

UpdateScratchPlateInput
object
8 properties
ScratchPlatePaginatedList
object
2 properties
ConcentrationWellInput
object
2 properties 2 required
ScratchPlateLayer
object
A named layer within a ScratchPlate, each backed by its own DataFrame.
3 properties
AnyType
ScratchPlateRef
object
2 properties
ContentItemInput
object
12 properties 3 required
MetadataColumnInput
object
5 properties 2 required
ScratchPlateMeasurementInput
object
9 properties 2 required
ScratchPlateWellInput
object
8 properties 2 required
QuantityInput
object
2 properties 1 required
InternalServerError
object
6 properties 5 required
TransferScratchPlatesResult
object
The scratch plate(s) produced by a transfer.
3 properties
AsyncTaskLink
object
2 properties
ScratchPlate
object
A plate design or record used for designing, tracking, and analyzing experimental plates outside of the inventory. Scratch plates are the working surface for p…
9 properties
BulkImport
object
1 property 1 required
CreateScratchPlateInput
object
14 properties 1 required
UnitInput
object
1 property
WellRoleInput
object
3 properties 1 required
ConcentrationLayerInput
object
4 properties 3 required
MetadataWellInput
object
2 properties 2 required
ScratchPlatePlateReaderAsmInput
object
1 property 1 required
ScratchPlateTransferInput
object
6 properties
WellTransferInput
object
9 properties 3 required
PlateSchemaRef
object
2 properties
ScratchPlateTransferRequestInput
object
6 properties 4 required
ParameterLayerInput
object
4 properties 3 required
ScratchPlateVendorFileInput
object
2 properties 2 required
GeneralError
object
5 properties 5 required
DataFrameRef
object
2 properties
ParameterWellInput
object
2 properties 2 required
UpdateScratchPlateInputWithPathParams
object
9 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchling-scratchplate-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 Scratch 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.