Skip to navigation
Benchling APIFeature Library Item

Create FeatureLibraryItem

Create FeatureLibraryItem.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
colorstringRequired

Must be a valid hex color string (for example, #F58A5E).

featureLibraryIdstringRequired
Feature library id to contain this feature. Each library supports at most 5,000 items.
matchTypeenumRequired

Determines how pattern is interpreted during auto-annotation (NUCLEOTIDE or AA_SEQUENCE). Required on create and cannot be changed on update.

Allowed values:
namestringRequired

Item names must be non-empty after trimming whitespace and at most 255 characters.

patternstringRequired

Patterns must be non-empty and valid for the item’s matchType. Nucleotide patterns accept IUPAC bases plus wildcards (#, <, >, ()). Amino acid patterns accept standard residues plus the same wildcard characters. Patterns are compared case-insensitively within a library, so two items cannot differ only by letter case.

featureTypestringOptional

The type of the Feature Library Item, like gene, promoter, etc. Note: This is an arbitrary string, not an enum

Response

Created
__typenamestringOptional
colorstringOptional
The color of the annotations generated by the Feature Library Item. Must be a valid hex string
createdAtstringOptional
DateTime the Feature Library Item was created
featureLibraryobjectOptional
The Feature Library the Feature Library Item belongs to
featureTypestring or nullOptional

The type of the Feature Library Item, like gene, promoter, etc. Note: This is an arbitrary string, not an enum

idstringOptional
matchTypeenumOptional

The match type of the Feature Library Item. Used to determine how auto-annotate matches are made

Allowed values:
modifiedAtstringOptional
DateTime the Feature Library Item was last modified
namestringOptional
The name of the Feature Library Item
patternstringOptional

The pattern used for matching during auto-annotation

Errors

400
Feature Library Item Create Request Bad Request Error
403
Feature Library Item Create Request Forbidden Error
404
Feature Library Item Create Request Not Found Error
409
Feature Library Item Create Request Conflict Error
429
Feature Library Item Create Request Too Many Requests Error
500
Feature Library Item Create Request Internal Server Error