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

An active execution of a procedure template. Created when scientists start running an experimentbased on a `Procedure`. Contains experimental conditions (`conditions` via `ProcedureRunCondition`)and their replicates, which in turn contain method execution instances (`methodExecutionInstances`via `ProcedureMethodExecutionInstance`) where actual data are recorded. Links to its template via`templateProcedureFlowchartVersion` or `procedureFlowchartConfigVersionProxy` and belongs to a `Study`. The`defaultDataEntryMode` (see `ProcedureRunDataEntryMode`) determines whether each condition-replicate has itsown worksheet or all share one. Workflow orchestration is managed through `workflowRootTaskGroup`.Also known as an "experiment" in the Benchling UI.

Benchling Procedure 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 ProcedureRun. 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 4 operations across 4 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

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

4 operations 4 paths 17 schemas 4 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 Procedure 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 4

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

ProcedureRun 4

An active execution of a procedure template. Created when scientists start running an experiment based on a Procedure. Contains experimental conditions (conditions via ProcedureRu…

GET
/procedure-run/items
List ProcedureRun items
ProcedureRun.List 22 params → 200400403404429500
GET
/procedure-run/{procedure_run_id}
Get ProcedureRun by ID
ProcedureRun.Get 4 params → 200400403404429500
GET
/procedure-run/{procedure_run_id}/conditions/items
List ProcedureRunCondition items
ProcedureRun.conditions.List 2 params → 200400403404429500
GET
/procedure-run/{procedure_run_id}/method-execution-instances/items
List ProcedureMethodExecutionInstance items
ProcedureRun.methodExecutionInstances.List 2 params → 200400403404429500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are ProcedureMethodExecutionInstance (19 properties), ProcedureRun (14 properties), ProcedureRunCondition (8 properties), InternalServerError (6 properties). Each schema is shown below with its type and property counts.

ProcedureRunPaginatedList
object
2 properties
ProcedureStepExecutionInstanceRef
object
2 properties
ProcedureRunRef
object
2 properties
ProcedureRun
object
An active execution of a procedure template. Created when scientists start running an experiment based on a Procedure. Contains experimental conditions (condit…
14 properties
InternalServerError
object
6 properties 5 required
ProcedureMethodDefinitionVersionRef
object
2 properties
ProcedureMethodExecutionInstanceUnpaginatedList
object
1 property
ProcedureMethodExecutionInstance
object
An instance of a method being executed within a procedure run. When a scientist runs a procedure, each method in the flowchart becomes a ProcedureMethodExecuti…
19 properties
PrincipalRef
object
2 properties
ProcedureRunConditionUnpaginatedList
object
1 property
ProcedureRunConditionReplicateRef
object
2 properties
ProcedureRunCondition
object
A ProcedureRunCondition represents a configuration of the methods of a Procedure that is being executed within a ProcedureRun. The values associated with the P…
8 properties
TaskTransitionExtension
object
Records a status change event on a method task during procedure execution. Captures the comment provided, the human-readable status name, and the timestamp whe…
4 properties
ProcedureFlowchartVersionRef
object
2 properties
ProcedureFlowchartConfigVersionProxyRef
object
2 properties
GeneralError
object
5 properties 5 required
ProcedureExecutionStepGroup
object
Groups step execution instances by their execution phase during a procedure run. Analogous to ProcedureStepGroup but contains actual execution instances (Proce…
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchling-procedurerun-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 Procedure 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.