Benchling Dna Sequence API is one of 203 APIs that Benchling publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include DnaSequence. 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
10 operations
across 9 paths,
and defines 92 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.
DnaSequenceUpdatedWebhookV3
Message body of a v3.dnaSequence.updated event.
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
WebhookApp
object
The Benchling App the webhook was delivered to.
1 property
1 required
ProjectRef
object
2 properties
AppInstallation
object
Represents an installed Benchling App on a tenant, created from an AppDefinitionVersion. App installations store tenant-specific configuration values and featu…
10 properties
CreateDnaSequenceInput
object
16 properties
3 required
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
User
object
Represents a human user in Benchling who can log in, perform actions, and own data. Users belong to one or more Organizations and may be members of Teams withi…
9 properties
CustomFieldInput
object
2 properties
1 required
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
AppConfigWorkflowTaskSchemaOutput
object
Defines the output field structure for a workflow task schema configuration.
2 properties
ResourceAppConfigSpec
object
Specifies that an app configuration field should reference a Benchling object instance. The type field identifies the kind of object required, matching the Ben…
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
FloatAppConfigSpec
object
Specifies that an app configuration field should accept a floating-point number.
3 properties
OligoRef
object
2 properties
WorkflowTaskSchemaAppConfigSpec
object
Specifies that an app configuration field should reference a workflow task schema. Kept separate from SchemaAppConfigSpec because it supports output field defi…
4 properties
EntitySchemaAppConfigSpec
object
Specifies that an app configuration field should reference an entity schema. Kept separate from SchemaAppConfigSpec because it carries a subtype constraint.
4 properties
AppConfigFieldDefinition
object
Defines a field within an app configuration that references schema fields. Specifies the field name, type, whether it accepts multiple values, and whether it i…
7 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
SchemaAppConfigSpec
object
Specifies that an app configuration field should reference one of the schema types that share a common structure: containerschema, plateschema, locationschema,…
4 properties
WebhookEnvelopeBaseV0
object
Fields common to every webhook request body. The event itself is carried in the message property of the event-specific payload.
5 properties
5 required
TranslationInput
object
8 properties
2 required
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
JsonAppConfigSpec
object
Specifies that an app configuration field should accept a JSON value.
2 properties
CanvasFeatureSpec
object
Defines a canvas feature for a Benchling App, which provides an embedded UI surface within entries or templates. Canvases allow apps to render custom interacti…
4 properties
TranslationRegionInput
object
2 properties
2 required
ObjectLinkValue
object
A type that represents links to other objects.
2 properties
V3UpdateEventBase
Fields common to every v3 update event message.
InternalServerError
object
6 properties
5 required
DecimalValue
object
A type that represents decimal value as strings.
3 properties
EntitySchemaRef
object
2 properties
BooleanAppConfigSpec
object
Specifies that an app configuration field should accept a boolean value.
2 properties
PrincipalRef
object
2 properties
TextAppConfigSpec
object
Specifies that an app configuration field should accept a text string.
3 properties
PrimerStartEndInput
object
3 properties
3 required
RegistryRef
object
2 properties
NucleotidePartInput
object
4 properties
3 required
SchemaFieldDefinitionRef
object
2 properties
ObjectLinkListValue
object
A type that represents a list of links to other objects.
2 properties
PrimerInput
object
3 properties
3 required
UpdateDnaSequenceInputWithPathParams
object
19 properties
1 required
LegacyAppInstallation
object
Represents a legacy (pre-App Store) Benchling App installation on a tenant. Legacy apps are configured directly with webhook URLs and configuration specs rathe…
17 properties
UpdateDnaSequenceInput
object
18 properties
DateAppConfigSpec
object
Specifies that an app configuration field should accept a date value.
2 properties
DnaSequenceRef
object
2 properties
AppMessageSubscription
object
Represents an app's subscription to a specific event type, specifying the event type and how notifications should be delivered (see DeliveryMethod).
3 properties
DateValue
object
A type that represents date values.
2 properties
DropdownAppConfigSpec
object
Specifies that an app configuration field should be a dropdown with predefined options.
3 properties
ArrayAppConfigSpec
object
Specifies that an app configuration field should accept an array of values.
5 properties
BooleanValue
object
A type that represents boolean values.
2 properties
PrincipalUnpaginatedList
object
1 property
DnaSequenceCreatedWebhookV3
Message body of a v3.dnaSequence.created event.
AssayRunFeatureSpec
object
Defines an assay run feature for a Benchling App, allowing the app to process or generate lab automation run data.
3 properties
DnaPart
object
Represents a region on a DNA sequence that matches or is derived from another registered DNA sequence. DnaPart features enable tracking the provenance of seque…
7 properties
AppHomepageFeatureSpec
object
Defines a homepage feature for a Benchling App, providing a dedicated landing page within the Benchling application for the app's functionality.
3 properties
BulkImport
object
1 property
1 required
DocumentLikeRef
object
2 properties
AssayRunFeatureValue
object
Links an app's assay run feature to a specific resource (typically a run schema) on a tenant. The featureId identifies the feature from the app definition, and…
3 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
ArrayAppConfigOption
object
A config option nested within an array-type app configuration field. Structurally identical to AppConfigOption — it has a name and a configSpec — but its confi…
4 properties
IntegerValue
object
A type that represents integer values.
2 properties
GeneralError
object
5 properties
5 required
ServicePrincipal
object
Represents a non-human identity used for system integrations and automated processes within Benchling. Service principals act as the identity for service accou…
4 properties
FieldValueInput
object
1 property
1 required
DnaSequenceUpdatedWebhookEnvelopeV3
Request body Benchling sends for a v3.dnaSequence.updated event.
DnaPartUnpaginatedList
object
1 property
RnaSequenceRef
object
2 properties
IDnaSequence
object
23 properties
AsyncTaskLink
object
2 properties
DnaSequencePaginatedList
object
2 properties
ArrayValue
object
A type that represents a list of BenchlingValues, used for multi-value cells (e.g. alias columns).
2 properties
WebhookAppDefinition
object
The app definition the receiving app was installed from.
2 properties
2 required
IntegerAppConfigSpec
object
Specifies that an app configuration field should accept an integer value.
3 properties
AppConfigOption
object
Defines a configuration option in an app's configuration schema. Each option has a name, optional description, and a configSpec defining the expected value typ…
4 properties
AppConfigDropdownOption
object
Defines an option within a dropdown-type app configuration field.
4 properties
ObjectRef
object
2 properties
DnaSequenceCreatedWebhookEnvelopeV3
Request body Benchling sends for a v3.dnaSequence.created event.
NucleotideAnnotationInput
object
8 properties
3 required
TextValue
object
A type that represents text (string) values.
2 properties
DateTimeAppConfigSpec
object
Specifies that an app configuration field should accept a datetime value.
2 properties
V3EventBase
object
Fields common to every v3 event message.
6 properties
6 required
PrimerBindPositionInput
object
3 properties
3 required
SecureTextAppConfigSpec
object
Specifies that an app configuration field should accept secure (encrypted) text. Used for sensitive data like API keys or credentials.
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Benchling publishes across the network.
