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 Custom Entities API

Benchling supports custom entities for biological entities that are neither DNA, RNA, nor AA sequences. Custom entities must have an entity schema set and can have both schema fields and custom fields.

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

Tagged areas include Custom Entities. 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 11 operations across 9 paths, and defines 41 schemas. It is described by OpenAPI 3.0.1, at version 2.0.0.

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

11 operations 9 paths 41 schemas 3 GET2 PATCH6 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 Custom Entities 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 9 paths, the API surfaces 11 operations — 3 GET, 2 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Custom Entities 11

Benchling supports custom entities for biological entities that are neither DNA, RNA, nor AA sequences. Custom entities must have an entity schema set and can have both schema fie…

GET
/custom-entities
List custom entities
listCustomEntities 22 params → 200400
POST
/custom-entities
Create a custom entity
createCustomEntity body → 201400503
GET
/custom-entities/{custom_entity_id}
Get a custom entity
getCustomEntity 2 params → 200400
PATCH
/custom-entities/{custom_entity_id}
Update a custom entity
updateCustomEntity 1 param body → 200400
PATCH
/custom-entities/{entity_registry_id}:upsert
Create or update a registered custom entity
upsertCustomEntity 1 param body → 200201400
POST
/custom-entities:archive
Archive custom entities
archiveCustomEntities body → 200400
POST
/custom-entities:bulk-create
Bulk Create custom entities
bulkCreateCustomEntities body → 202400
GET
/custom-entities:bulk-get
Bulk get custom entities by ID
bulkGetCustomEntities 2 params → 200400
POST
/custom-entities:bulk-update
Bulk Update custom entities
bulkUpdateCustomEntities body → 202400
POST
/custom-entities:bulk-upsert
Bulk upsert custom entities
bulkUpsertCustomEntities body → 202400
POST
/custom-entities:unarchive
Unarchive custom entities
unarchiveCustomEntities body → 200400

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are CustomEntity (18 properties), CustomEntityBaseRequest (7 properties), EntityUpsertBaseRequest (5 properties), Field (5 properties). Each schema is shown below with its type and property counts.

CustomEntityBaseRequest
object
7 properties
CustomEntity
object
18 properties
Fields
object
FieldWithResolution
CustomEntitiesBulkUpsertRequest
object
1 property 1 required
CustomEntitiesBulkUpdateRequest
object
1 property 1 required
CustomField
object
1 property
CustomEntitiesArchivalChange
object
IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of custom entities along with any IDs of batches that were a…
2 properties
CustomEntitiesPaginatedList
object
2 properties
BadRequestError
object
1 property
CustomEntitiesBulkCreateRequest
object
1 property 1 required
CustomEntityBulkUpdate
object
1 property 1 required
ArchiveRecordSet
object
Currently, we only support setting a null value for archiveRecord, which unarchives the item
SchemaFieldsQueryParam
object
BaseError
object
3 properties
ArchiveRecord
object
1 property
FieldType
string
CustomEntitiesUnarchive
object
The request body for unarchiving custom entities.
1 property 1 required
FieldsWithResolution
object
FieldValueWithResolution
CustomEntitiesArchive
object
The request body for archiving custom entities.
2 properties 2 required
NamingStrategy
string
Specifies the behavior for automatically generated names when registering an entity. - NEWIDS: Generate new registry IDs - IDSFROMNAMES: Generate registry IDs…
UserSummary
CustomEntityUpdate
CustomEntityRequestRegistryFields
object
1 property
Field
object
5 properties 1 required
PartySummary
object
3 properties
CustomEntityCreate
CustomEntityBulkUpsertRequest
AsyncTaskLink
object
1 property
CustomFields
object
EntityBulkUpsertBaseRequest
CustomEntityUpsertRequest
RegistrationOrigin
object
2 properties
CustomEntityBaseRequestForCreate
EntityUpsertBaseRequest
object
5 properties 3 required
CreateEntityIntoRegistry
object
4 properties
CustomEntitiesList
object
1 property
CustomEntityBulkCreate
SchemaSummary
object
2 properties
EntityArchiveReason
string
The reason for archiving the provided entities. Accepted reasons may differ based on tenant configuration.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchling-custom-entities-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 Notations API
Where this information came from

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