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

Create and manage Benchling apps on your tenant

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

Tagged areas include Application. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a changelog, and a status page.

This API exposes 20 operations across 14 paths, and defines 139 schemas. It is described by OpenAPI 3.0.1, at version 2.0.0.

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

20 operations 14 paths 139 schemas 6 GET4 PATCH10 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
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 Apps 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 20

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

Apps 20

Create and manage Benchling apps on your tenant

POST
/app-canvases
Create an App Canvas
createAppCanvas body → 201400403
GET
/app-canvases/{canvas_id}
Get App Canvas
getAppCanvas 2 params → 200404
PATCH
/app-canvases/{canvas_id}
Update App Canvas
updateAppCanvas 1 param body → 200403404
POST
/app-canvases:archive
Archive app canvases
archiveAppCanvases body → 200400
POST
/app-canvases:unarchive
Unarchive app canvases
unarchiveAppCanvases body → 200400
GET
/app-configuration-items
Get app configuration items
listAppConfigurationItems 6 params → 200404
POST
/app-configuration-items
Create app configuration item
createAppConfigurationItem body → 201400
GET
/app-configuration-items/{item_id}
Get app configuration item
getAppConfigurationItemById 1 param → 200404
PATCH
/app-configuration-items/{item_id}
Update app configuration item
updateAppConfigurationItem 1 param body → 200403404
POST
/app-configuration-items:bulk-create
Bulk Create app configuration items. Limit of 1000 App Config Items per request.
bulkCreateAppConfigurationItems body → 202400
POST
/app-configuration-items:bulk-update
Bulk Update app configuration items. Limit of 1000 App Config Items per request.
bulkUpdateAppConfigurationItems body → 202400
POST
/app-sessions
Create a new app session
createAppSession body → 201400403
GET
/app-sessions/{id}
Get an app session
getAppSessionById 2 params → 200404
PATCH
/app-sessions/{id}
Update app session
updateAppSession 1 param body → 200400403404
GET
/apps
List apps
listBenchlingApps 12 params → 200400403
POST
/appsdeprecated
Create an app
createBenchlingApp body → 201400403409
GET
/apps/{app_id}
Get an app by ID
getBenchlingAppByID 1 param → 200400403404
PATCH
/apps/{app_id}deprecated
Update an app
patchBenchlingApp 1 param body → 200400403404
POST
/apps:archivedeprecated
Archive apps
archiveBenchlingApps body → 200400
POST
/apps:unarchivedeprecated
Unarchive apps
unarchiveBenchlingApps body → 200400

Schemas 139

The contract defines 139 schemas that model the data the API accepts and returns. The most detailed are AppSession (8 properties), AppConfigItemApiMixin (7 properties), AppSessionCreate (4 properties), BaseError (3 properties). Each schema is shown below with its type and property counts.

SelectorInputMultiValueUiBlockUpdate
object
FileUploadUiBlock
object
MarkdownUiBlock
object
3 properties 2 required
AppCanvasUpdateBase
object
TextInputUiBlockUpdate
object
ArrayElementAppConfigItem
AppConfigItemJsonCreate
object
AppConfigItemJsonBulkUpdate
object
SectionUiBlock
object
AppSessionUpdateStatus
string
Values that can be specified when updating the status of a Session
AppConfigItemDateCreate
object
AppConfigItem
object
SelectorInputMultiValueUiBlock
object
DropdownUiBlock
object
ArchiveRecord
object
1 property
AppConfigItemsBulkUpdateRequest
object
1 property 1 required
SearchInputUiBlockCreate
object
MarkdownUiBlockCreate
object
AppConfigItemGenericCreate
object
AppCanvasUpdate
object
AppCanvasLeafNodeUiBlockList
object
1 property 1 required
AppCanvasUpdateUiBlockList
object
1 property
AppCanvasesArchivalChange
object
IDs of all items that were archived or unarchived. This includes the IDs of canvases that were archived / unarchived.
1 property
DatetimeAppConfigItem
AppConfigItemsBulkCreateRequest
object
1 property 1 required
TableUiBlockCreate
object
UserInputUiBlock
object
DropdownMultiValueUiBlockCreate
object
BenchlingAppCreate
object
2 properties 1 required
AppCanvas
object
NotFoundError
object
1 property
DropdownMultiValueUiBlock
object
ChipUiBlockCreate
object
BenchlingAppsArchive
object
2 properties 2 required
DropdownUiBlockUpdate
object
SchemaDependencySubtypes
string
AppSessionMessageCreate
object
2 properties 1 required
AppCanvasCreate
object
ButtonUiBlock
object
AppConfigItemIntegerCreate
object
ConflictError
object
1 property
SearchInputUiBlock
object
ButtonUiBlockUpdate
object
BenchlingAppsPaginatedList
GenericApiIdentifiedAppConfigItem
object
AppConfigItemFloatBulkUpdate
object
JsonAppConfigItem
AppConfigItemDateBulkUpdate
object
AppConfigItemGenericUpdate
object
2 properties 2 required
AppConfigItemBooleanCreate
object
FloatAppConfigItem
object
AppSession
object
8 properties
AppConfigItemIntegerBulkUpdate
object
SearchInputMultiValueUiBlockUpdate
object
BenchlingApp
AppConfigItemApiMixin
object
7 properties
AsyncTaskLink
object
1 property
UserInputMultiValueUiBlock
object
FileUploadUiBlockCreate
object
BaseAppConfigItem
object
AppSessionUpdate
object
Update a session's messages or increase timeoutSeconds.
3 properties
BaseSelectorInputUIBlock
object
AppConfigItemFloatUpdate
object
2 properties 2 required
AppConfigItemBooleanBulkUpdate
object
InteractiveUiBlock
object
2 properties 1 required
AppConfigItemGenericBulkUpdate
object
SearchInputUiBlockItemType
string
AppConfigItemBulkUpdateMixin
object
1 property 1 required
SelectorInputUiBlock
object
AppConfigItemCreateMixin
object
2 properties 2 required
DropdownUiBlockCreate
object
AppSessionMessage
object
SearchInputMultiValueUiBlock
object
AppConfigItemUpdate
object
BaseError
object
3 properties
DateAppConfigItem
SectionUiBlockCreate
object
ChipUiBlock
object
AppConfigItemDatetimeBulkUpdate
object
AppCanvasBase
object
TextInputUiBlockCreate
object
AppConfigItemDatetimeUpdate
object
2 properties 2 required
MarkdownUiBlockUpdate
object
AppConfigItemBooleanUpdate
object
2 properties 2 required
AppSessionStatus
string
All possible values of a Session's status, including system-updated and user-updated values.
PartySummary
object
3 properties
AppCanvasUiBlockList
object
1 property
TableUiBlockDatasetSource
object
2 properties 2 required
BenchlingAppsUnarchive
object
1 property 1 required
AppSessionCreate
object
4 properties 3 required
BaseDropdownUIBlock
object
InaccessibleResource
object
3 properties
LinkedAppConfigResourceSummary
object
2 properties
AppSummary
object
1 property
AppConfigurationPaginatedList
object
SectionUiBlockUpdate
object
AppCanvasCreateUiBlockList
object
1 property
AppConfigItemFloatCreate
object
FieldAppConfigItem
AppSessionMessageStyle
string
AppCanvasesArchive
object
2 properties 2 required
ButtonUiBlockCreate
object
AppConfigItemIntegerUpdate
object
2 properties 2 required
BadRequestError
object
1 property
BenchlingAppUpdate
object
2 properties
FileUploadUiBlockUpdate
object
TextInputUiBlock
object
SearchInputUiBlockUpdate
object
IntegerAppConfigItem
object
SecureTextAppConfigItem
object
Pagination
object
1 property
SelectorInputMultiValueUiBlockCreate
object
ChipUiBlockUpdate
object
BenchlingAppsArchivalChange
object
IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of apps that were archived / unarchived.
1 property
TableUiBlockDataFrameSource
object
2 properties 2 required
AppCanvasesUnarchive
object
1 property 1 required
TableUiBlockUpdate
object
AppConfigItemDateUpdate
object
2 properties 2 required
BooleanAppConfigItem
object
UserSummary
ForbiddenError
object
1 property
AppConfigItemCreate
object
LinkedAppConfigResource
object
DropdownMultiValueUiBlockUpdate
object
TextAppConfigItem
object
AppConfigItemBulkUpdate
object
TableUiBlock
object
BaseSearchInputUIBlock
object
SelectorInputUiBlockUpdate
object
AppCanvasesArchiveReason
string
Reason that canvases are being archived. Actual reason enum varies by tenant.
AppCanvasCreateBase
object
AppConfigItemJsonUpdate
object
2 properties 2 required
LinkedAppConfigResourceMixin
object
1 property
AppConfigItemDatetimeCreate
object
SelectorInputUiBlockCreate
object
AppCanvasWriteBase
object
SearchInputMultiValueUiBlockCreate
object
TableUiBlockSource
object
EntitySchemaAppConfigItem

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchling-apps-api-openapi.yml Raw ↑

Other APIs Benchling publishes across the network.

Benchling AA Sequences 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
Benchling Custom Notations API
Where this information came from

This is an independent, third-party profile of Benchling Apps 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.