Benchling Worklist API is one of 203 APIs that Benchling publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Worklist. 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
11 operations
across 9 paths,
and defines 109 schemas.
It is described by OpenAPI 3.2.0, at version 2.0.0.
Requests are made against a single base URL, /api/v3.
The identity and technical contract details declared by the specification.
AaAnnotation
object
Represents an annotated region on an amino acid sequence (AaSequence). Annotations mark functional domains, binding sites, post-translational modifications, en…
9 properties
GridCoordinates
object
Read model representing a fillable position in a box or plate.
5 properties
Transcription
object
Represents a transcribed region on a DNA sequence that produces an RNA product. Transcriptions link a region of a DnaSequence to the corresponding RnaSequence…
5 properties
MatrixPlatePosition
object
A well position within a MatrixPlate.
3 properties
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
IMolecule
object
17 properties
IMixture
object
19 properties
ProteinFormatRef
object
2 properties
ProjectRef
object
2 properties
Primer
object
Represents a primer binding site on a nucleotide sequence, indicating where an oligonucleotide primer anneals for PCR amplification or sequencing. The Primer l…
7 properties
CustomField
object
A name-value pair for storing additional metadata on objects that support custom fields. CustomFields provide a flexible way to attach arbitrary string data to…
3 properties
SchemaFieldValue
object
Represents a field value on a schematized object, pairing a fieldDefinition (describing the field's type and constraints) with its actual value (a BenchlingVal…
5 properties
AaSequenceRef
object
2 properties
ExpirationInfo
object
Provides expiration tracking for inventory items such as containers and their contents. The expirationDate may be explicitly set on the container or inherited…
3 properties
DateTimeValue
object
A type that represents datetime values.
2 properties
RegistrationOrigin
object
Captures the provenance of an entity's registration into the registry. The originEntry links to the DocumentLike (typically an entry or notebook) from which th…
3 properties
Translation
object
Represents a protein-coding region (CDS) on a nucleotide sequence, showing the translated amino acid sequence. Translations can span a single contiguous region…
12 properties
FolderRef
object
2 properties
OligoRef
object
2 properties
JsonValue
object
A type that represents JSON values.
2 properties
TextAndUrlValue
object
A type that represents text (string) values with an associated URL.
3 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
RegionsListItem
object
Represents a contiguous position range within a Translation or other multi-region feature. For spliced genes or complex reading frames, a Translation may span…
3 properties
EntityRef
object
2 properties
ChemSimplePolymer
object
Represents a small molecule within a complex polymer structure. Contains SMILES and molfile representations of the chemical structure, along with connections t…
7 properties
ProteinChain
object
Represents a polypeptide chain within an Protein, containing the domain composition. Each chain has a computed label derived from the format.
6 properties
ExperimentalRole
object
Represents the complete experimental designation of a well or container within an assay, combining a primary role (see PrimaryExperimentalRole), replicate grou…
4 properties
ComplexPolymerStructure
object
Contains the complete structural definition of a complex polymer, including all component polymers and their interconnections. This is the core data structure…
4 properties
ObjectLinkValue
object
A type that represents links to other objects.
2 properties
ComplexPolymerResolvedAttachment
object
Detailed information about a group of contiguous connections in a complex polymer. The entire chemical structure of the connection group, and any components in…
3 properties
InternalServerError
object
6 properties
5 required
DecimalValue
object
A type that represents decimal value as strings.
3 properties
EntitySchemaRef
object
2 properties
ProteinDomain
object
Represents a domain within an Protein, containing the actual amino acid sequence for a specific label. Unlike ProteinFormatDomain which is a template, ProteinD…
5 properties
PrincipalRef
object
2 properties
Ingredient
object
Represents a single component within a Mixture, specifying the substance and its amount. Each Ingredient references a componentEntity (the substance being adde…
11 properties
ContainerSchemaRef
object
2 properties
DeleteWorklistInputWithPathParams
object
1 property
1 required
ComplexPolymerConnection
object
Represents a chemical bond between two polymers within a complex polymer structure. Connections can be covalent bonds (including disulfide bonds) or hydrogen b…
6 properties
UpdateWorklistInputWithPathParams
object
5 properties
1 required
RegistryRef
object
2 properties
IOligoConjugate
object
An oligo conjugate is a specific type of complex polymer that consists of a single short DNA/RNA strand with multiple attached molecules (aka conjugates).
23 properties
IRnaOligo
object
18 properties
SchemaFieldDefinitionRef
object
2 properties
ObjectLinkListValue
object
A type that represents a list of links to other objects.
2 properties
NucleotideSequenceRef
object
2 properties
EntityAssociation
object
Every entity association maps a Benchling entity to one or more HELM references in the complex polymer. These HELM polymers each have the same chemical structu…
3 properties
DateValue
object
A type that represents date values.
2 properties
IContainer
object
20 properties
IRnaSequence
object
21 properties
CreateWorklistInput
object
3 properties
2 required
BooleanValue
object
A type that represents boolean values.
2 properties
PeptideSimplePolymer
object
Represents a peptide or protein chain within a complex polymer structure. Contains the amino acid residue sequence and connections to other polymers. The entit…
6 properties
IPlate
object
16 properties
ICustomEntity
object
15 properties
WorklistableUnpaginatedList
object
1 property
LocationRef
object
2 properties
BulkImport
object
1 property
1 required
DocumentLikeRef
object
2 properties
NucleotideMonomerRef
object
2 properties
NucleotideAnnotation
object
Represents a biological feature annotation on a nucleotide sequence (DNA or RNA). Annotations mark regions of interest such as genes, promoters, terminators, r…
8 properties
IMatrixPlate
object
15 properties
UpdateWorklistInput
object
4 properties
Assembly
object
Represents a molecular cloning assembly that combines multiple DNA fragments into complete constructs. Assemblies model the process of joining fragment sequenc…
9 properties
Worklist
object
A typed collection of items used to group related objects for batch operations. Unlike folders, items can belong to multiple worklists simultaneously, making w…
9 properties
IntegerValue
object
A type that represents integer values.
2 properties
GeneralError
object
5 properties
5 required
CheckoutRecord
object
Tracks the checkout status of an inventory item such as a Container. When laboratory samples need to be temporarily removed from storage (e.g., for an experime…
5 properties
WellPlateSchemaRef
object
2 properties
OwnerRef
object
2 properties
RnaSequenceRef
object
2 properties
IDnaSequence
object
23 properties
WellPlatePosition
object
Represents a single well within a WellPlate, functioning as a fixed container at a specific grid position. Each WellPlatePosition has coordinates identifying i…
11 properties
IProtein
object
22 properties
IAaSequence
object
17 properties
NucleotideSimplePolymer
object
Represents a nucleic acid strand (DNA or RNA) within a complex polymer structure. Contains the sequence residues, any chemical modifications (see ModifiedNucle…
8 properties
WorklistPaginatedList
object
2 properties
AsyncTaskLink
object
2 properties
ArrayValue
object
A type that represents a list of BenchlingValues, used for multi-value cells (e.g. alias columns).
2 properties
ContainerContent
object
Represents a biological or chemical entity stored within a Container or well. Each ContainerContent links an Entity (such as a DNA sequence, protein, or custom…
5 properties
MatrixPlateSchemaRef
object
2 properties
Measurement
object
Represents a quantity with an associated unit of measurement within Benchling's inventory system. Measurements are used throughout inventory to track container…
3 properties
MoleculeRef
object
2 properties
ConnectionSide
object
Represents one endpoint of a connection between polymers in a complex polymer structure. Identifies the specific attachment point including the polymer referen…
5 properties
IWellPlate
object
11 properties
ModifiedNucleotide
object
Represents a chemically modified nucleotide at a specific position in an oligonucleotide sequence. Each modification specifies the sugar, base, and phosphate m…
8 properties
IDnaOligo
object
18 properties
ObjectRef
object
2 properties
ContainerRef
object
2 properties
PlateSchemaRef
object
2 properties
TextValue
object
A type that represents text (string) values.
2 properties
IOligoDuplex
object
An oligo duplex is a specific type of complex polymer that consists of two complementary DNA/RNA strands, with multiple attached molecules on either strand (ak…
25 properties
UnitRef
object
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Benchling publishes across the network.
