Skip to navigation
Benchling APIProtein

Create and register proteins and components

Beta

Create and register proteins and their component parts (domains, chains, and variable pairs)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

EARLY-ACCESSstringOptional

Set to true to access beta operations via /api/v3.

Request

This endpoint expects an object.
folderIdstringRequired
The ID of the folder in which the new entities should be created.
newComponentConfigobjectRequired
Schema IDs for new component entities created during this request. Applies to all rows in the request.
proteinCreateInputslist of anyRequired
proteinSchemaIdstringRequired
The schema ID for the protein entity type.
entryIdstringOptional
The ID of the notebook entry into which the creation results will be embedded upon completion. If omitted, no results are written to a notebook entry.
germlineConfigslist of objects or nullOptional
A list of germline configs indicating the germline with which to annotate each domain key. This applies to all rows in the request.
translationParametersobjectOptional
The translation parameters to use when creating AA sequences. Required if the request contains DNA sequences. May be omitted if the request contains only AA sequences.

Response

Job status details
pollingUristringformat: "uri"
A URL to poll for the status of the task.
taskIdstring

Errors

400
Proteins and Components Bulk Create Request Bad Request Error
403
Proteins and Components Bulk Create Request Forbidden Error
404
Proteins and Components Bulk Create Request Not Found Error
429
Proteins and Components Bulk Create Request Too Many Requests Error
500
Proteins and Components Bulk Create Request Internal Server Error