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

Boxes are a structured inventory type, consisting of a grid of positions that can each hold one container. Unlike locations, there are a maximum number of containers that a box can hold (one per position).Boxes are all associated with schemas, which define the type of the box (e.g. "10x10 Cryo Box") along with the fields that are tracked and the dimensions of the box.Like all inventory, every Box has a barcode that is unique across the registry.

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

Tagged areas include Boxes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a changelog, and a status page.

This API exposes 8 operations across 6 paths, and defines 76 schemas. It is described by OpenAPI 3.0.1, at version 2.0.0.

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

8 operations 6 paths 76 schemas 4 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
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 Boxes 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 6 paths, the API surfaces 8 operations — 4 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Boxes 8

Boxes are a structured inventory type, consisting of a grid of positions that can each hold one container. Unlike locations, there are a maximum number of containers that a box ca…

GET
/boxes
List boxes
listBoxes 28 params → 200400
POST
/boxes
Create a box
createBox body → 201400
GET
/boxes/{box_id}
Get a box
getBox 1 param → 200400
PATCH
/boxes/{box_id}
Update a box
updateBox 1 param body → 200400403404
GET
/boxes/{box_id}/contents
List a box's contents
listBoxContents 4 params → 200400404
POST
/boxes:archive
Archive boxes
archiveBoxes body → 200403
GET
/boxes:bulk-get
BulkGet boxes
bulkGetBoxes 2 params → 200400
POST
/boxes:unarchive
Unarchive boxes
unarchiveBoxes body → 200

Schemas 76

The contract defines 76 schemas that model the data the API accepts and returns. The most detailed are RnaSequence (29 properties), DnaSequence (27 properties), Mixture (21 properties), Container (21 properties). Each schema is shown below with its type and property counts.

Molecule
object
19 properties
ForbiddenRestrictedSampleError
object
1 property
EntityLabels
object
3 properties
Primer
object
9 properties
CustomEntity
object
18 properties
Box
object
19 properties
RnaOligoWithEntityType
object
TeamSummary
DnaSequenceWithEntityType
object
ContainerQuantity
object
Quantity of a container, well, or transfer. Supports mass, volume, and other quantities.
2 properties
AaSequenceWithEntityType
object
BoxesArchive
object
3 properties 2 required
Fields
object
RnaSequencePart
BoxesUnarchive
object
1 property 1 required
DeprecatedContainerVolumeForResponse
BoxesPaginatedList
object
2 properties
Measurement
object
2 properties 2 required
CustomEntityWithEntityType
object
CustomField
object
1 property
NucleotideSequencePart
object
3 properties
DnaOligoWithEntityType
object
BoxUpdate
object
4 properties
EntityOrInaccessibleResource
object
BadRequestError
object
1 property
SequenceFeatureCustomField
object
A name and value pair associated with a sequence feature (annotation or translation). For genbank imports, these are the qualifiers associated with each featur…
2 properties
Entity
object
AaAnnotation
object
7 properties
DnaAnnotation
SequenceFeatureBase
object
4 properties
SampleRestrictionStatus
string
ExperimentalWellRole
object
3 properties
RnaOligo
BoxesArchivalChange
object
IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of boxes along with any IDs of containers that were archived…
2 properties
SchemaFieldsQueryParam
object
BoxContentsPaginatedList
object
2 properties
ArchiveRecord
object
1 property
BoxesBulkGet
object
1 property
BaseError
object
3 properties
IngredientMeasurementUnits
string
MoleculeWithEntityType
object
FieldType
string
MixtureWithEntityType
object
BoxCreate
object
6 properties 1 required
DnaOligo
UserSummary
Mixture
object
21 properties
ForbiddenError
object
1 property
ContainerLabels
object
3 properties
DnaSequenceSummary
object
3 properties
Translation
Field
object
5 properties 1 required
PartySummary
object
3 properties
DnaSequencePart
DnaSequenceTranscription
object
4 properties
AaSequenceSummary
object
3 properties
BatchOrInaccessibleResource
ContainerWithCoordinates
CustomEntitySummary
object
3 properties
CheckoutRecord
object
assignee field is set if status is "RESERVED" or "CHECKEDOUT", or null if status is "AVAILABLE". comment field is set when container was last reserved, checked…
4 properties
CustomFields
object
Oligo
object
20 properties
RnaSequenceWithEntityType
object
RnaSequence
object
29 properties
Batch
object
11 properties
NotFoundError
object
1 property
RegistrationOrigin
object
2 properties
MixtureMeasurementUnits
string
Container
object
21 properties
RnaAnnotation
ContainerContent
object
3 properties
DnaSequence
object
27 properties
AaSequence
object
21 properties
Ingredient
object
10 properties
InaccessibleResource
object
3 properties
SchemaSummary
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchling-boxes-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 Codon Usage Tables API
Benchling Connect API
Benchling Containers API
Benchling Custom Entities API
Benchling Custom Notations API
Where this information came from

This is an independent, third-party profile of Benchling Boxes 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.