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 Analysis Template API

A reusable pipeline configuration that can be instantiated to create new Analysis objects.AnalysisTemplates define a complete data processing workflow with PipelineSteps (see `steps`)that can be parameterized through configVariables (see `AnalysisTemplateVariable`) anddataFrameVariables (see `AnalysisTemplateDataFrameVariable`). When users apply a template,they provide values for these variables, generating a new Analysis with the template'spipeline structure populated with actual data. Templates are organized withinTemplateCollections and support versioning through the createdFromPipeline reference.

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

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

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

6 operations 6 paths 18 schemas 6 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 Analysis Template 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 6

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

AnalysisTemplate 6

A reusable pipeline configuration that can be instantiated to create new Analysis objects. AnalysisTemplates define a complete data processing workflow with PipelineSteps (see ste…

GET
/analysis-template/items
List AnalysisTemplate items
AnalysisTemplate.List 20 params → 200400403404429500
GET
/analysis-template/{analysis_template_id}
Get AnalysisTemplate by ID
AnalysisTemplate.Get 4 params → 200400403404429500
GET
/analysis-template/{analysis_template_id}/archivable-children/items
List AnalysisTemplateDataFrameVariable items
AnalysisTemplate.archivableChildren.List 2 params → 200400403404429500
GET
/analysis-template/{analysis_template_id}/config-variables/items
List AnalysisTemplateVariable items
AnalysisTemplate.configVariables.List 2 params → 200400403404429500
GET
/analysis-template/{analysis_template_id}/data-frame-variables/items
List AnalysisTemplateDataFrameVariable items
AnalysisTemplate.dataFrameVariables.List 2 params → 200400403404429500
GET
/analysis-template/{analysis_template_id}/steps/items
List PipelineStep items
AnalysisTemplate.steps.List 2 params → 200400403404429500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are AnalysisTemplate (18 properties), AnalysisTemplateDataFrameVariable (15 properties), AnalysisTemplateVariable (13 properties), PipelineStep (12 properties). Each schema is shown below with its type and property counts.

PipelineStep
object
Represents a single operation node within a Pipeline's directed acyclic graph (DAG). Each step performs a specific transformation determined by its stepType (s…
12 properties
PipelineStepUnpaginatedList
object
1 property
DataFrameColumn
object
Defines a column within a DataFrame, including its internal system name, user-facing display name, and data type specification.
4 properties
AnalysisTemplate
object
A reusable pipeline configuration that can be instantiated to create new Analysis objects. AnalysisTemplates define a complete data processing workflow with Pi…
18 properties
InternalServerError
object
6 properties 5 required
PipelineRef
object
2 properties
AnalysisTemplateDataFrameVariable
object
Defines a data frame placeholder within an AnalysisTemplate that users must provide when applying the template. Each variable specifies which PipelineStep inpu…
15 properties
PipelineStepRef
object
2 properties
PrincipalRef
object
2 properties
AnalysisTemplateVariableUnpaginatedList
object
1 property
AnalysisTemplateVariable
object
Defines a configuration parameter within an AnalysisTemplate that users can customize when applying the template. Unlike AnalysisTemplateDataFrameVariable whic…
13 properties
AnalysisTemplatePaginatedList
object
2 properties
PipelineStepDataRef
object
2 properties
AnalysisTemplateRef
object
2 properties
AnalysisRef
object
2 properties
AnalysisTemplateDataFrameVariableUnpaginatedList
object
1 property
GeneralError
object
5 properties 5 required
TemplateCollectionRef
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchling-analysistemplate-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 Analysis Template 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.