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

A Run represents an execution instance of a lab automation workflow in Benchling, capturingthe inputs, outputs, and metadata for a single assay or instrument operation. Runs conformto a RunSchema that defines their structure including input generators (see AutomationInputGenerator)for creating worklists and output processors (see AutomationOutputProcessor) for parsinginstrument results. Runs are typically embedded in notebook entries (via the entry field)and can generate associated Analyses for data processing. Each run tracks validation status(VALID or INVALID) with optional comments, enabling quality control workflows. Runs belongto a Project for access control and can be archived when superseded or invalidated. Alsoknown as "assay runs" in the lab automation context.

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

Tagged areas include Run. 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 2 operations across 2 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

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

2 operations 2 paths 29 schemas 2 GET

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 Run 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 2

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

Run 2

A Run represents an execution instance of a lab automation workflow in Benchling, capturing the inputs, outputs, and metadata for a single assay or instrument operation. Runs conf…

GET
/run/items
List Run items
Run.List 20 params → 200400403404429500
GET
/run/{run_id}
Get Run by ID
Run.Get 4 params → 200400403404429500

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are IRun (11 properties), V3EventBase (6 properties), InternalServerError (6 properties), WebhookEnvelopeBaseV0 (5 properties). Each schema is shown below with its type and property counts.

IRun
object
11 properties
DateValue
object
A type that represents date values.
2 properties
BooleanValue
object
A type that represents boolean values.
2 properties
WebhookApp
object
The Benchling App the webhook was delivered to.
1 property 1 required
ProjectRef
object
2 properties
ObjectLinkValue
object
A type that represents links to other objects.
2 properties
RunSchemaRef
object
2 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
ArrayValue
object
A type that represents a list of BenchlingValues, used for multi-value cells (e.g. alias columns).
2 properties
RunCreatedWebhookV3
Message body of a v3.run.created event.
WebhookAppDefinition
object
The app definition the receiving app was installed from.
2 properties 2 required
RunCreatedWebhookEnvelopeV3
Request body Benchling sends for a v3.run.created event.
PrincipalRef
object
2 properties
DocumentLikeRef
object
2 properties
DateTimeValue
object
A type that represents datetime values.
2 properties
RunPaginatedList
object
2 properties
ObjectRef
object
2 properties
Run
TextValue
object
A type that represents text (string) values.
2 properties
V3EventBase
object
Fields common to every v3 event message.
6 properties 6 required
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
WebhookEnvelopeBaseV0
object
Fields common to every webhook request body. The event itself is carried in the message property of the event-specific payload.
5 properties 5 required
GeneralError
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchling-run-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 Run 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.