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 Protein Format API

A ProteinFormat defines the structural template for a class of proteins, specifying thearrangement of chains and domains. Formats can be built-in (e.g., IgG1, Fab, scFv) orcustom-defined by users.

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

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

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

8 operations 7 paths 14 schemas 2 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 Protein Format 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 8

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

ProteinFormat 8

A ProteinFormat defines the structural template for a class of proteins, specifying the arrangement of chains and domains. Formats can be built-in (e.g., IgG1, Fab, scFv) or custo…

POST
/protein-format
Create ProteinFormat
ProteinFormat.Create 1 param body → 201400403404429500
GET
/protein-format/items
List ProteinFormat items
ProteinFormat.List 17 params → 200400403404429500
GET
/protein-format/{protein_format_id}
Get ProteinFormat by ID
ProteinFormat.Get 4 params → 200400403404429500
PATCH
/protein-format/{protein_format_id}
Update ProteinFormat
ProteinFormat.Update 2 params body → 200400403404429500
POST
/protein-format:batch-create
Batch create ProteinFormat
ProteinFormat.BatchCreate 1 param body → 201400403404429500
PATCH
/protein-format:batch-update
Batch update ProteinFormat
ProteinFormat.BatchUpdate 1 param body → 200400403404429500
POST
/protein-format:bulk-create
Bulk create ProteinFormat
ProteinFormat.BulkCreate 1 param body → 202400403404429500
PATCH
/protein-format:bulk-update
Bulk update ProteinFormat
ProteinFormat.BulkUpdate 1 param body → 202400403404429500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are ProteinFormat (13 properties), InternalServerError (6 properties), ProteinFormatChain (5 properties), GeneralError (5 properties). Each schema is shown below with its type and property counts.

ProteinFormatChainPosition
object
Defines each instance of a polypeptide chain within a ProteinFormat, specifying the chain type and its constituent domains. Each chain position has a unique re…
4 properties
InternalServerError
object
6 properties 5 required
ProteinFormatChain
object
A chain in a protein format, representing the slot where a polypeptide chain can be used in an entity of this format. Chains are uniquely identified by their l…
5 properties
AsyncTaskLink
object
2 properties
UpdateProteinFormatInputWithPathParams
object
4 properties 1 required
BulkImport
object
1 property 1 required
UpdateProteinFormatInput
object
3 properties
PrincipalRef
object
2 properties
CreateProteinFormatInput
object
2 properties 1 required
ProteinFormatPaginatedList
object
2 properties
ProteinFormatDomain
object
A domain in a protein format, representing the slot where an amino acid sequence can be used in an entity of this format. Domains are uniquely identified by th…
5 properties
ProteinFormatDomainPosition
object
Defines a domain position within a1 ProteinFormat, specifying the domain type and identity of each physical domain in the protein format. Each domain position…
4 properties
GeneralError
object
5 properties 5 required
ProteinFormat
object
A ProteinFormat defines the structural template for a class of proteins, specifying the arrangement of chains and domains. Formats can be built-in (e.g., IgG1,…
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchling-proteinformat-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 Protein Format 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.