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 App Canvas API

Represents a Benchling App canvas, an embedded UI surface that apps use to render custominteractive content within notebook entries, entry templates, assay runs, or app homepages.Each canvas belongs to a single app and contains a list of UI blocks that define thecanvas layout and interactivity.

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

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

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

7 operations 6 paths 37 schemas 1 GET3 PATCH3 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 App Canvas 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 7

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

AppCanvas 7

Represents a Benchling App canvas, an embedded UI surface that apps use to render custom interactive content within notebook entries, entry templates, assay runs, or app homepages…

POST
/app-canvas
Create AppCanvas
AppCanvas.Create 1 param body → 201400403404429500
GET
/app-canvas/{app_canvas_id}
Get AppCanvas by ID
AppCanvas.Get 4 params → 200400403404429500
PATCH
/app-canvas/{app_canvas_id}
Update AppCanvas
AppCanvas.Update 2 params body → 200400403404429500
POST
/app-canvas:batch-create
Batch create AppCanvas
AppCanvas.BatchCreate 1 param body → 201400403404429500
PATCH
/app-canvas:batch-update
Batch update AppCanvas
AppCanvas.BatchUpdate 1 param body → 200400403404429500
POST
/app-canvas:bulk-create
Bulk create AppCanvas
AppCanvas.BulkCreate 1 param body → 202400403404429500
PATCH
/app-canvas:bulk-update
Bulk update AppCanvas
AppCanvas.BulkUpdate 1 param body → 202400403404429500

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are AppCanvas (13 properties), SearchInputUiBlockInput (9 properties), SearchInputUiBlock (9 properties), SearchInputMultiValueUiBlock (9 properties). Each schema is shown below with its type and property counts.

IAppInstallationRef
object
2 properties
TableUiBlock
object
A table block that displays tabular data from a dataset or data frame.
5 properties
SectionUiBlockInput
object
3 properties 3 required
SearchInputUiBlockInput
object
9 properties 3 required
AppCanvasUiBlockInput
object
MarkdownUiBlock
object
A block that renders Markdown content.
3 properties
TextInputUiBlock
object
A text input block that accepts freeform user text.
7 properties
SelectorInputMultiValueUiBlock
object
A multi-select selector input block with predefined options.
8 properties
DropdownUiBlockInput
object
8 properties 3 required
ChipUiBlockInput
object
3 properties 3 required
UiBlockLeafNodeInput
object
UpdateAppCanvasInputWithPathParams
object
7 properties 1 required
UpdateAppCanvasInput
object
6 properties
MarkdownUiBlockInput
object
3 properties 3 required
SearchInputMultiValueUiBlock
object
A multi-select search input block for selecting multiple Benchling entities.
9 properties
InternalServerError
object
6 properties 5 required
AsyncTaskLink
object
2 properties
ButtonUiBlockInput
object
4 properties 3 required
SelectorInputUiBlockInput
object
8 properties 3 required
BulkImport
object
1 property 1 required
FileUploadUiBlock
object
A file upload block that accepts one or more file attachments.
8 properties
SearchInputMultiValueUiBlockInput
object
9 properties 3 required
TableUiBlockInput
object
5 properties 4 required
SectionUiBlock
object
A section block that groups child blocks together. Children are leaf blocks only.
3 properties
SelectorInputMultiValueUiBlockInput
object
8 properties 3 required
DropdownMultiValueUiBlockInput
object
8 properties 3 required
CreateAppCanvasInput
object
7 properties 4 required
FileUploadUiBlockInput
object
8 properties 2 required
SearchInputUiBlock
object
A search input block for selecting a single Benchling entity.
9 properties
ChipUiBlock
object
A chip block that displays a short piece of information.
3 properties
DropdownMultiValueUiBlock
object
A multi-select dropdown block backed by a Benchling dropdown registry.
8 properties
SelectorInputUiBlock
object
A selector input block with predefined options.
8 properties
DropdownUiBlock
object
A dropdown block backed by a Benchling dropdown registry.
8 properties
GeneralError
object
5 properties 5 required
TextInputUiBlockInput
object
7 properties 2 required
AppCanvas
object
Represents a Benchling App canvas, an embedded UI surface that apps use to render custom interactive content within notebook entries, entry templates, assay ru…
13 properties
ButtonUiBlock
object
A button block that triggers an app interaction when clicked.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchling-appcanvas-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 App Canvas 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.