Benchling Document Part API is one of 203 APIs that Benchling publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include DocumentPart. 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
2 operations
across 2 paths,
and defines 90 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
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
DocumentPart
object
Represents an ordered piece of content within an entry, template, subtemplate, or document. Each document part wraps one content block and records its containe…
7 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
ProteinFormatRef
object
2 properties
DocumentEmbeddable
object
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
ReviewRef
object
2 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
EntrySchemaRef
object
2 properties
RunSchemaRef
object
2 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
LinkSpan
object
LinkSpan is used when we want to apply a URL to a particular span of the text.
4 properties
AaSequenceRef
object
2 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
Mention
object
Represents an inline mention of another Benchling item within text content. Mentions allow users to reference entities (sequences, samples, entries, etc.) dire…
3 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
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
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
ListItemDocumentContent
object
Represents a single list item within notebook or document content. List items store their marker style, rich text, and indentation for ordered, unordered, and…
7 properties
CodeBlockDocumentContent
object
Represents a block of code or preformatted text within notebook or document content. Code blocks preserve the text content for display as a standalone code blo…
2 properties
ObjectLinkValue
object
A type that represents links to other objects.
2 properties
DocumentLikeVersionMetadata
object
Version metadata for a DocumentLike-style entry. Captures the API identifier of a particular version snapshot together with the time that version was produced.…
3 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
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
IEntry
object
18 properties
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
TableCellSelector
object
A predefined dropdown selector that can be assigned to table cells.
4 properties
SchemaFieldDefinitionRef
object
2 properties
ObjectLinkListValue
object
A type that represents a list of links to other objects.
2 properties
HeaderDocumentContent
object
Represents a heading block within notebook or document content. Headers store the heading level, rich text, and indentation used to organize document sections.
7 properties
UnstructuredTableDocumentContentSummary
object
An unstructured (plain) table embedded within a notebook entry. Unlike structured tables, unstructured tables have freeform cells without typed columns. Cells…
6 properties
NucleotideSequenceRef
object
2 properties
UnresolvableEmbeddedItem
object
An embedded Benchling item that exists in the system but cannot be fetched via the V3 REST API (currently Protocols, Equipment, and Trial Subjects). It has no…
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
AttachmentDocumentContent
object
Represents an external file attachment embedded in notebook or document content. Attachments expose file metadata, a temporary download URL, and indentation wi…
8 properties
RunRef
object
2 properties
DateValue
object
A type that represents date values.
2 properties
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
ICustomEntity
object
15 properties
DocumentLikeRef
object
2 properties
NucleotideMonomerRef
object
2 properties
SectionDocumentContent
object
Represents a section divider within notebook or document content. Sections can include a title, date, and color to group related document parts.
4 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
TableColumnDefinition
object
A column definition within a table, specifying the label and optional width.
4 properties
IntegerValue
object
A type that represents integer values.
2 properties
GeneralError
object
5 properties
5 required
DocumentPartPaginatedList
object
2 properties
RnaSequenceRef
object
2 properties
IDnaSequence
object
23 properties
IProtein
object
22 properties
EntryContent
object
Represents a single content item within an EntrySection. The type field indicates what kind of content this is (see ContentType). This provides a simplified vi…
2 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
BenchlingItemDocumentContent
object
Represents a Benchling item embedded in notebook or document content, identifying the referenced Benchling object.
3 properties
ArrayValue
object
A type that represents a list of BenchlingValues, used for multi-value cells (e.g. alias columns).
2 properties
TextDocumentContent
object
Represents a paragraph of formatted text content within a notebook entry or document. TextDocumentContent is the primary way to store narrative text in the ele…
6 properties
MoleculeRef
object
2 properties
TextBoxDocumentContent
object
Represents a fill-in text box within a notebook entry. Text boxes are labeled input fields that can be added to entry templates to capture specific pieces of i…
9 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
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
TextFormat
object
A TextFormat applies a set of TextFormatProperties to some range within a text. Examples here would include font properties like bold, italic or underline as w…
6 properties
EntrySection
object
Represents a logical section within an Entry used to organize content into collapsible groups. While sections include a date field and were historically known…
5 properties
ObjectRef
object
2 properties
RunDocumentContent
object
Represents a run embedded in notebook or document content. Run content connects a document part to its run schema and, when available, the specific run.
4 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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Benchling publishes across the network.
