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

A draft experiment plan that can be promoted to a `ProcedureRun` for execution. Scientists userun plans to configure experimental conditions, parameter values, and replicates beforestarting an actual experiment. Belongs to a `Study` and references a procedure template viaeither `templateProcedureFlowchartVersion` (for legacy flowcharts) or`procedureFlowchartConfigVersionProxy` (for new-style workflow flowcharts). Contains`ProcedureRunPlanCondition` objects that define the different experimental configurations totest. The `dataEntryMode` (see `ProcedureRunDataEntryMode`) specifies whether eachcondition-replicate will have its own data entry worksheet or share a single worksheet. The`confirmationMethodByParamVersionId` allows overriding default confirmation methods forspecific parameters. Upon promotion, the run plan becomes a `ProcedureRun` with corresponding`ProcedureRunCondition` and `ProcedureRunConditionReplicate` objects. Also known as a "draftexperiment" in the Benchling UI.

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

Tagged areas include ProcedureRunPlan. 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 11 operations across 10 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.

11 operations 10 paths 29 schemas 4 GET3 PATCH4 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 Procedure Run Plan 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 11

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

ProcedureRunPlan 11

A draft experiment plan that can be promoted to a ProcedureRun for execution. Scientists use run plans to configure experimental conditions, parameter values, and replicates befor…

POST
/procedure-run-plan
Create ProcedureRunPlan
ProcedureRunPlan.Create 1 param body → 201400403404429500
GET
/procedure-run-plan/items
List ProcedureRunPlan items
ProcedureRunPlan.List 16 params → 200400403404429500
GET
/procedure-run-plan/{procedure_run_plan_id}
Get ProcedureRunPlan by ID
ProcedureRunPlan.Get 4 params → 200400403404429500
PATCH
/procedure-run-plan/{procedure_run_plan_id}
Update ProcedureRunPlan
ProcedureRunPlan.Update 2 params body → 200400403404429500
GET
/procedure-run-plan/{procedure_run_plan_id}/procedure-run-plan-conditions/items
List ProcedureRunPlanCondition items
ProcedureRunPlan.procedureRunPlanConditions.List 2 params → 200400403404429500
POST
/procedure-run-plan:batch-create
Batch create ProcedureRunPlan
ProcedureRunPlan.BatchCreate 1 param body → 201400403404429500
PATCH
/procedure-run-plan:batch-update
Batch update ProcedureRunPlan
ProcedureRunPlan.BatchUpdate 1 param body → 200400403404429500
POST
/procedure-run-plan:bulk-create
Bulk create ProcedureRunPlan
ProcedureRunPlan.BulkCreate 1 param body → 202400403404429500
PATCH
/procedure-run-plan:bulk-update
Bulk update ProcedureRunPlan
ProcedureRunPlan.BulkUpdate 1 param body → 202400403404429500
POST
/procedure-run-plan:promote
Turn procedure run plans into active procedure runs. Plans must not already be converted. Returns an async task — poll the task endpoint for completion and the created procedure run IDs
ProcedureRunPlan.Promote 1 param body → 202400403404429500
GET
/tasks/procedure-run-plan/promote/{task_id}
Poll async task status
ProcedureRunPlan.Promote.Get 2 params → 200400403404429500

Schemas 29

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

EquipmentValuePlan
object
A pre-filled value for an equipment parameter within a MethodParametersPlan. The equipmentId references the ProcedureParameterVersion for the equipment paramet…
3 properties
ProcedureRunPlan
object
A draft experiment plan that can be promoted to a ProcedureRun for execution. Scientists use run plans to configure experimental conditions, parameter values,…
13 properties
PromoteProcedureRunPlanInput
object
1 property 1 required
ConfirmationMethodByParamVersionId
object
Associates a procedure parameter version with its confirmation method, keyed by the parameter version ID. Used in ProcedureRunPlan to look up how a specific ve…
3 properties
ProcedureRunRef
object
2 properties
ProcedureRunPlanConditionReplicate
object
Represents a planned replicate within a ProcedureRunPlanCondition. Scientists often run the same experimental condition multiple times to obtain statistically…
3 properties
DataParameterValuePlan
object
A pre-filled value for a data parameter within a MethodParametersPlan. The parameterId references the ProcedureParameterVersion this value applies to. The valu…
3 properties
InternalServerError
object
6 properties 5 required
ProcedureMethodDefinitionVersionRef
object
2 properties
AsyncTaskLink
object
2 properties
UpdateProcedureRunPlanInputWithPathParams
object
6 properties 1 required
CreateProcedureRunPlanInput
object
5 properties 5 required
ProcedureRunPlanPaginatedList
object
2 properties
BulkImport
object
1 property 1 required
PromotedProcedureRunItem
object
A single procedure run created by promoting a procedure run plan.
3 properties
PrincipalRef
object
2 properties
ConfirmationMethodByParamVersionIdInput
object
2 properties 2 required
ProcedureRunPlanConditionUnpaginatedList
object
1 property
MethodParametersPlan
object
Contains the planned parameter values for a single unit operation (method) within a ProcedureRunPlanCondition. Links to a ProcedureMethodDefinitionVersion via…
4 properties
StudyRef
object
2 properties
ConditionOrderForPmdvInput
object
2 properties 2 required
ProcedureRunPlanCondition
object
A planned experimental condition within a ProcedureRunPlan, representing how a procedure's methods will be configured when the plan is promoted to an actual Pr…
11 properties
PromoteProcedureRunPlanOutput
object
Output returned when promoting procedure run plans to active procedure runs.
1 property
ProcedureRunPlanRef
object
2 properties
ProcedureFlowchartVersionRef
object
2 properties
ProcedureFlowchartConfigVersionProxyRef
object
2 properties
GeneralError
object
5 properties 5 required
UpdateProcedureRunPlanInput
object
5 properties
MaterialInputValuePlan
object
A pre-filled value for a material input within a MethodParametersPlan. The materialInputId references the ProcedureParameterVersion for the material input this…
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchling-procedurerunplan-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 Plan 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.